UNCLASSIFIED - NO CUI

Update Administrator Guide authored by Mark Howard's avatar Mark Howard
......@@ -92,7 +92,21 @@ 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
as true. For example, `FEATURE_XXX="true"`. where `XXX` is the feature name.
#### TEAM_VIEWS
If this experimental feature is enabled, then alternative views can be made for a team. These alternative views will not get included in the rollup for owning value stream or organization. This allows a team to use a second board that only includes a subset of their workflow (maybe only high priority items), allowing a different set of metrics to be viewable without double counting items for the value stream or organization.
#### COST_METRICS
If this experimental feature is enabled, then a separate dashboard showing the metrics with currency calculations instead of time. If SSO is enabled as well, then only users that are part of a specific SSO group can access this part of the application. This can be provided to the API with the environment variable `SSO_LEADERSHIP_GROUP`.
The cost metrics are built using pay data that is uploaded in a CSV format. Once again, if SSO is enabled, only those who are part of the previously mentioned SSO group can upload this data. The CSV should include pay rates and e-mail addresses.
#### DEPLOY_FREQUENCY
If this experimental feature is enabled, Holocron will report metrics on how often team's deploy their projects. This is based on build job status and as such requires a consistent use of job names.
## [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:
1. Your hosted GitLab's graphql query complexity must be a maximum of 234.
1. Your hosted GitLab's GraphQL maximum query complexity must be no lower than 234.