Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with executions endpoints and ACL example #67

Merged
merged 3 commits into from
May 18, 2023

Conversation

davidcpell
Copy link
Contributor

@davidcpell davidcpell commented May 18, 2023

Recently I was setting up a new API token following "principle of least privilege" so that the token's user would only be able to make the minimum API calls necessary to obtain metrics from the endpoints used by rundeck_exporter. The official API reference isn't consistent in explaining which policies are necessary for an endpoint, so this involved a lot of trial and error. I thought it might be helpful for other users to have an example of example which policy rules are necessary for rundeck_exporter to work.

This PR:

  • updates the list of endpoints used by rundeck_exporter to include project execution endpoints, and turns each item in the bulleted list into a link to the API documentation for that endpoint
  • adds a YAML example of minimum required ACL policies that can be copy/pasted into the Rundeck "Edit ACL Policy" Editor box.

@phsmith phsmith added the documentation Improvements or additions to documentation label May 18, 2023
Copy link
Owner

@phsmith phsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic @davidcpell!
Thank you so much for your contribution.
It's really a great addition to know about!

@phsmith phsmith merged commit 82b203a into phsmith:main May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants