manifoldco / manifoldco/torus-cli
Gatekeeper: documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 603
- Forks
- 30
- PR merge metrics
- No merged PRs in 30d
Description
Documentation is required for the Gatekeeper. The Torus documentation should provide how to run the Gatekeeper, and how to bootstrap a machine. Some notes for documentation:
`torus gatekeeper start` -- start the Gatekeeper instance
`torus machines bootstrap` -- bootstrap a machine against a Gatekeeper instance
`--auth` and `--url` are required to provide the authentication provider type (currently only `aws`), and the URL of the Gatekeeper instance. `--role` and `--org` are required only if the Gatekeeper instance does not have configured defaults for Torus.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Torus documentation and the `torus gatekeeper start` and `torus machines bootstrap` entry points. Document how to run Gatekeeper, bootstrap a machine, and use `--auth`, `--url`, `--role`, and `--org`; done means these workflows and option requirements are clear to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100