UNCLASSIFIED - NO CUI

Update Administrator Guide authored by abhayashrestha's avatar abhayashrestha
...@@ -71,6 +71,8 @@ Every collector needs the following environmental variables for setup: ...@@ -71,6 +71,8 @@ Every collector needs the following environmental variables for setup:
- `MAX_REQUESTS_PER_MINUTE`: represents the threshold for the amount of requests that can be sent to `TARGET_URL` in a minute before the collector instance needs to stop sending requests for a brief period of time. - `MAX_REQUESTS_PER_MINUTE`: represents the threshold for the amount of requests that can be sent to `TARGET_URL` in a minute before the collector instance needs to stop sending requests for a brief period of time.
- `ACCESS_TOKEN`: the token that must be set in order for the collector to retrieve data from whatever API might need the token (example: GitLab, Jira etc.). - `ACCESS_TOKEN`: the token that must be set in order for the collector to retrieve data from whatever API might need the token (example: GitLab, Jira etc.).
Finally, there are additional specifics that some of the collectors will need for which you can find more on the [Collector Specifics](collector-specifics) section.
## Environmental Variables needed for the API ## Environmental Variables needed for the API
The API needs the following environmental variables for the setup: The API needs the following environmental variables for the setup:
- `DB_USER`: the postgres database user. - `DB_USER`: the postgres database user.
...@@ -82,7 +84,7 @@ The API needs the following environmental variables for the setup: ...@@ -82,7 +84,7 @@ The API needs the following environmental variables for the setup:
- `SSO_ADMIN_GROUP`: the SSO group name for admin access. - `SSO_ADMIN_GROUP`: the SSO group name for admin access.
- `SSO_LEADERSHIP_GROUP`: the SSO group name for leadership access. - `SSO_LEADERSHIP_GROUP`: the SSO group name for leadership access.
- `SSO_GROUPS_KEY`: the key found in user token indicating the list of groups a user is part of (this can include `SSO_ADMIN_GROUP`, `SSO_LEADERSHIP_GROUP` values in the list). This list will determine what SSO permissions a user has. For example, if `SSO_GROUPS_KEY="foo"` and `SSO_ADMIN_GROUP="bar"` is set, then the API will try and check the user token (as a sample token json `{"foo": ["bar"]}`) to determine if user is admin which in this case the user is admin. - `SSO_GROUPS_KEY`: the key found in user token indicating the list of groups a user is part of (this can include `SSO_ADMIN_GROUP`, `SSO_LEADERSHIP_GROUP` values in the list). This list will determine what SSO permissions a user has. For example, if `SSO_GROUPS_KEY="foo"` and `SSO_ADMIN_GROUP="bar"` is set, then the API will try and check the user token (as a sample token json `{"foo": ["bar"]}`) to determine if user is admin which in this case the user is admin.
- `SSO_USERNAME_KEY`: the key found in user token indicating the user's username. For example, if the `SSO_USERNAME_KEY="foo"` is set, then the API would get the username by checking the token (as a sample token json `{"foo": "bar"}` for `foo` as key. - `SSO_USERNAME_KEY`: the key found in user token indicating the user's username. For example, if the `SSO_USERNAME_KEY="foo"` is set, then the API would get the username by checking the token (as a sample token json `{"foo": "bar"}`) for `foo` as key. In this case, the username would be `bar`.
- `OPENAPI_VERSION`: the open api version for the app to use. - `OPENAPI_VERSION`: the open api version for the app to use.
- `MODE`: the mode of operation for the app (can be "production" or "development") - `MODE`: the mode of operation for the app (can be "production" or "development")
...@@ -90,7 +92,7 @@ The API needs the following environmental variables for the setup: ...@@ -90,7 +92,7 @@ The API needs the following environmental variables for the setup:
The API can enable experimental features by setting the variable name that describes the feature The API can enable experimental features by setting the variable name that describes the feature
as true. For example, `FEATURE_XXX="true"`. where `XXX` is the feature name. as true. For example, `FEATURE_XXX="true"`. where `XXX` is the feature name.
## Collector Specifics ## [Collector Specifics](collector-specifics)
- **GitLab Workflow Collector**: In addition to the setup needed for environmental variables, you will need the following requirements to be met in order to be able to use this collector: - **GitLab Workflow Collector**: In addition to the setup needed for environmental variables, you will need the following requirements to be met in order to be able to use this collector:
1. Your hosted GitLab's graphql query complexity must be a maximum of 234. 1. Your hosted GitLab's graphql query complexity must be a maximum of 234.