Getting Started with Big Bang📜
This is a guide for deploying Holocron as part of Big Bang.
Basics📜
Database📜
Holocron expects a PostgreSQL database. Set the following values:
.Values.addons.holocron.database.host.Values.addons.holocron.database.port.Values.addons.holocron.database.database.Values.addons.holocron.database.username.Values.addons.holocron.database.password
SSO & RBAC📜
If you want to utilize RBAC in Holocron, you will need an SSO set up. Details on the SSO setup can be found here. Set .Values.addons.holocron.sso.enabled to true and .Values.addons.holocron.sso.groups.admin to your SSO group value.
Post Deployment Setup📜
Once you have successfully deployed, you will need to assign roles to users. Any user in the admin group will automatically have full rights. They will need to create the organization(s) used and assign users to adminstrate them. For a user to be available, they must have accessed your Holocron instance at least once. More details on setting up Organizations/Value Streams/Teams can be found here.
GitLab📜
If deploying with GitLab, Holocron will attempt to collect metrics from it, but you will need to provide it access. Create an access token for Holocron to utilize. It needs read access to all groups and repositories that you want it to collect from. We recommend creating an auditor for this purpose. Provide this access token to .Values.addons.holocron.collectorAuth.gitlabToken.
Holocron will deploy collectors for Build (pipelines), SCM (commits, branches, MRs), and Workflow (issues). If any of these are not desired, provide an empty array to .Values.addons.holocron.values.<collectorType>.instances. For example, if you do not want to collect issues from GitLab, set .Values.addons.holocron.values.collectorGitlabWorkflow.instances to [].
Workflow Collector Settings📜
The Workflow collector may require additional settings depending on how issue labels are used. A list of labels can be defined for the various priorities and effort type. Defaults can be found here. To update these, set .Values.addons.holocron.values.collectorGitlabWorkflow.instances[0].env.<key> to a comma delineated list of label values.
SonarQube📜
if deploying with SonarQube, Holocron will attempt to collect metrics from it, but you will need to provide it access. Create an access token for Holocron to utilize. It needs read access to all projects that you want it to collect from. Provide this access token to .Values.addons.holocron.collectorAuth.sonarToken.
If this collection is not desired, set .Values.addons.holocron.values.collectorSonarQubeProjectAnalysis to [].
Jira📜
If deploying with Jira, Holocron will need to be told about it in order to collect metrics from it. If desired, set .Values.addons.holocron.jira.enabled to true and .Values.addons.holocron.jira.service.name to the kubernetes service name (including port). If network policies are enabled, you must also set a key value pair under .Values.addons.holocron.jira.service.label. This should be set to a kubernetes label used by the Jira webservice pod.