Reorganize SensuFlow readme #45
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hillaryfraley
commented
Jul 13, 2022
|
|
||
| ## Install SensuFlow | ||
|
|
||
| **TODO** |
There was a problem hiding this comment.
What do users need to clone/download/install to use SensuFlow in their own repos? Is it something like this:
- Clone the SensuFlow repo (or reproduce it in Bitbucket or GitLab, if not using GitHub).
- Add your namespace directories and resource files (with appropriate labels and following the prescribed directory structure).
- Configure the Sensu RBAC service account.
- Configure env vars required to use SensuFlow and aspects of the CI/CD service (secrets; pipeline files; other).
Anything else?
Is there a different install process for people who the Docker image?
hillaryfraley
commented
Jul 13, 2022
|
|
||
| ### Set environment variables | ||
|
|
||
| **TODO** |
There was a problem hiding this comment.
Are env vars for SensuFlow set differently than env vars for Sensu? -- or does this depend on the CI/CD service in use?
|
Hey @jspaleta please let me know if I missed the mark or you need further help here! After straightening out the install process (such as it may be), I can probably make a few more updates in the readme. |
hillaryfraley
commented
Jul 13, 2022
| SENSU_API_URL | String | Required | Sensu backend API URL (the URL used to configure `sensuctl`, such as `https://sensu.example.com:8080`). | ||
| SENSU_CA | String | Optional | Certificate Authority (CA) file as a string. Use the SENSU_CA variable if you want to encode the CA file as a GitHub Actions secret. | ||
| SENSU_CA_FILE | String | Optional | Certificate Authority (CA) file location. The SENSU_CA_FILE value (if provided) overrides the SENSU_CA value. | ||
| VERBOSE | Integer | Optional | If set, shows verbose description of actions carried out by the script. |
There was a problem hiding this comment.
I'm not sure if VERBOSE should be included here or not.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reorganizes content in the existing readme as well as pages in https://github.com/sensu/sensu-flow/tree/main/docs.
Closes #44