diff --git a/README.md b/README.md index 6f4fdc23f7c5207fcc36acf09c092efe16891da9..41bb0b542b2fa9f3d7ff840149e3fed68eb97ccc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # bigbang -  +  Big Bang is a declarative, continuous delivery tool for core DoD hardened and approved packages into a Kubernetes cluster. @@ -67,7 +67,7 @@ To start using Big Bang, you will need to create your own Big Bang environment t | istio.enabled | bool | `true` | Toggle deployment of Istio. | | istio.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/core/istio-controlplane.git"` | | | istio.git.path | string | `"./chart"` | | -| istio.git.tag | string | `"1.11.2-bb.1"` | | +| istio.git.tag | string | `"1.11.3-bb.1"` | | | istio.ingressGateways.public-ingressgateway.type | string | `"LoadBalancer"` | | | istio.ingressGateways.public-ingressgateway.kubernetesResourceSpec | object | `{}` | | | istio.gateways.public.ingressGateway | string | `"public-ingressgateway"` | | @@ -81,14 +81,14 @@ To start using Big Bang, you will need to create your own Big Bang environment t | istiooperator.enabled | bool | `true` | Toggle deployment of Istio Operator. | | istiooperator.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/core/istio-operator.git"` | | | istiooperator.git.path | string | `"./chart"` | | -| istiooperator.git.tag | string | `"1.11.2-bb.0"` | | +| istiooperator.git.tag | string | `"1.11.3-bb.0"` | | | istiooperator.flux | object | `{}` | Flux reconciliation overrides specifically for the Istio Operator Package | | istiooperator.values | object | `{}` | Values to passthrough to the istio-operator chart: https://repo1.dso.mil/platform-one/big-bang/apps/core/istio-operator.git | | istiooperator.postRenderers | list | `[]` | Post Renderers. See docs/postrenders.md | | jaeger.enabled | bool | `true` | Toggle deployment of Jaeger. | | jaeger.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/core/jaeger.git"` | | | jaeger.git.path | string | `"./chart"` | | -| jaeger.git.tag | string | `"2.23.0-bb.4"` | | +| jaeger.git.tag | string | `"2.26.0-bb.0"` | | | jaeger.flux | object | `{"install":{"crds":"CreateReplace"},"upgrade":{"crds":"CreateReplace"}}` | Flux reconciliation overrides specifically for the Jaeger Package | | jaeger.ingress.gateway | string | `""` | | | jaeger.sso.enabled | bool | `false` | Toggle SSO for Jaeger on and off | @@ -99,7 +99,7 @@ To start using Big Bang, you will need to create your own Big Bang environment t | kiali.enabled | bool | `true` | Toggle deployment of Kiali. | | kiali.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/core/kiali.git"` | | | kiali.git.path | string | `"./chart"` | | -| kiali.git.tag | string | `"1.40.1-bb.0"` | | +| kiali.git.tag | string | `"1.40.1-bb.1"` | | | kiali.flux | object | `{}` | Flux reconciliation overrides specifically for the Kiali Package | | kiali.ingress.gateway | string | `""` | | | kiali.sso.enabled | bool | `false` | Toggle SSO for Kiali on and off | @@ -124,7 +124,7 @@ To start using Big Bang, you will need to create your own Big Bang environment t | logging.enabled | bool | `true` | Toggle deployment of Logging (EFK). | | logging.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/core/elasticsearch-kibana.git"` | | | logging.git.path | string | `"./chart"` | | -| logging.git.tag | string | `"0.1.21-bb.2"` | | +| logging.git.tag | string | `"0.1.21-bb.3"` | | | logging.flux | object | `{"timeout":"20m"}` | Flux reconciliation overrides specifically for the Logging (EFK) Package | | logging.ingress.gateway | string | `""` | | | logging.sso.enabled | bool | `false` | Toggle OIDC SSO for Kibana/Elasticsearch on and off. Enabling this option will auto-create any required secrets. | @@ -143,14 +143,14 @@ To start using Big Bang, you will need to create your own Big Bang environment t | fluentbit.enabled | bool | `true` | Toggle deployment of Fluent-Bit. | | fluentbit.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/core/fluentbit.git"` | | | fluentbit.git.path | string | `"./chart"` | | -| fluentbit.git.tag | string | `"0.16.6-bb.0"` | | +| fluentbit.git.tag | string | `"0.16.6-bb.1"` | | | fluentbit.flux | object | `{}` | Flux reconciliation overrides specifically for the Fluent-Bit Package | | fluentbit.values | object | `{}` | Values to passthrough to the fluentbit chart: https://repo1.dso.mil/platform-one/big-bang/apps/core/fluentbit.git | | fluentbit.postRenderers | list | `[]` | Post Renderers. See docs/postrenders.md | | monitoring.enabled | bool | `true` | Toggle deployment of Monitoring (Prometheus, Grafana, and Alertmanager). | | monitoring.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/core/monitoring.git"` | | | monitoring.git.path | string | `"./chart"` | | -| monitoring.git.tag | string | `"14.0.0-bb.11"` | | +| monitoring.git.tag | string | `"14.0.0-bb.17"` | | | monitoring.flux | object | `{"install":{"crds":"CreateReplace"},"upgrade":{"crds":"CreateReplace"}}` | Flux reconciliation overrides specifically for the Monitoring Package | | monitoring.ingress.gateway | string | `""` | | | monitoring.sso.enabled | bool | `false` | Toggle SSO for monitoring components on and off | @@ -168,7 +168,7 @@ To start using Big Bang, you will need to create your own Big Bang environment t | twistlock.enabled | bool | `true` | Toggle deployment of Twistlock. | | twistlock.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/security-tools/twistlock.git"` | | | twistlock.git.path | string | `"./chart"` | | -| twistlock.git.tag | string | `"0.0.9-bb.1"` | | +| twistlock.git.tag | string | `"0.0.10-bb.0"` | | | twistlock.flux | object | `{}` | Flux reconciliation overrides specifically for the Twistlock Package | | twistlock.ingress.gateway | string | `""` | | | twistlock.values | object | `{}` | Values to passthrough to the twistlock chart: https://repo1.dso.mil/platform-one/big-bang/apps/security-tools/twistlock.git | @@ -204,19 +204,19 @@ To start using Big Bang, you will need to create your own Big Bang environment t | addons.minio.enabled | bool | `false` | Toggle deployment of minio. | | addons.minio.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/application-utilities/minio.git"` | | | addons.minio.git.path | string | `"./chart"` | | -| addons.minio.git.tag | string | `"4.2.3-bb.5"` | | +| addons.minio.git.tag | string | `"4.2.3-bb.6"` | | | addons.minio.flux | object | `{}` | Flux reconciliation overrides specifically for the Minio Package | | addons.minio.ingress.gateway | string | `""` | | | addons.minio.accesskey | string | `""` | Default access key to use for minio. | | addons.minio.secretkey | string | `""` | Default secret key to intstantiate with minio, you should change/delete this after installation. | | addons.minio.values | object | `{}` | Values to passthrough to the minio instance chart: https://repo1.dso.mil/platform-one/big-bang/apps/application-utilities/minio.git | | addons.minio.postRenderers | list | `[]` | Post Renderers. See docs/postrenders.md | -| addons.gitlab.enabled | bool | `false` | Toggle deployment of Gitlab | +| addons.gitlab.enabled | bool | `false` | Toggle deployment of Gitlab | | addons.gitlab.hostnames.gitlab | string | `"gitlab"` | | | addons.gitlab.hostnames.registry | string | `"registry"` | | | addons.gitlab.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/developer-tools/gitlab.git"` | | | addons.gitlab.git.path | string | `"./chart"` | | -| addons.gitlab.git.tag | string | `"5.3.1-bb.2"` | | +| addons.gitlab.git.tag | string | `"5.3.1-bb.4"` | | | addons.gitlab.flux | object | `{}` | Flux reconciliation overrides specifically for the Gitlab Package | | addons.gitlab.ingress.gateway | string | `""` | | | addons.gitlab.sso.enabled | bool | `false` | Toggle OIDC SSO for Gitlab on and off. Enabling this option will auto-create any required secrets. | @@ -231,40 +231,41 @@ To start using Big Bang, you will need to create your own Big Bang environment t | addons.gitlab.objectStorage.type | string | `""` | Type of object storage to use for Gitlab, setting to s3 will assume an external, pre-existing object storage is to be used. Entering connection info will enable this option and will auto-create any required secrets | | addons.gitlab.objectStorage.endpoint | string | `""` | S3 compatible endpoint to use for connection information. examples: "https://s3.amazonaws.com" "https://s3.us-gov-west-1.amazonaws.com" "http://minio.minio.svc.cluster.local:9000" | | addons.gitlab.objectStorage.region | string | `""` | S3 compatible region to use for connection information. | -| addons.gitlab.objectStorage.accessKey | string | `""` | Access key for connecting to object storage endpoint. | +| addons.gitlab.objectStorage.accessKey | string | `""` | Access key for connecting to object storage endpoint. -- If using accessKey and accessSecret, the iamProfile must be left as an empty string: "" | | addons.gitlab.objectStorage.accessSecret | string | `""` | Secret key for connecting to object storage endpoint. Unencoded string data. This should be placed in the secret values and then encrypted | | addons.gitlab.objectStorage.bucketPrefix | string | `""` | Bucket prefix to use for identifying buckets. Example: "prod" will produce "prod-gitlab-bucket" | +| addons.gitlab.objectStorage.iamProfile | string | `""` | NOTE: Current bug with AWS IAM Profiles and Object Storage where only artifacts are stored. Fixed in Gitlab 14.5 -- Name of AWS IAM profile to use. -- If using an AWS IAM profile, the accessKey and accessSecret values must be left as empty strings eg: "" | | addons.gitlab.values | object | `{}` | Values to passthrough to the gitlab chart: https://repo1.dso.mil/platform-one/big-bang/apps/developer-tools/gitlab.git | | addons.gitlab.postRenderers | list | `[]` | Post Renderers. See docs/postrenders.md | | addons.gitlabRunner.enabled | bool | `false` | Toggle deployment of Gitlab Runner | | addons.gitlabRunner.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/developer-tools/gitlab-runner.git"` | | | addons.gitlabRunner.git.path | string | `"./chart"` | | -| addons.gitlabRunner.git.tag | string | `"0.33.1-bb.2"` | | +| addons.gitlabRunner.git.tag | string | `"0.33.1-bb.4"` | | | addons.gitlabRunner.flux | object | `{}` | Flux reconciliation overrides specifically for the Gitlab Runner Package | | addons.gitlabRunner.values | object | `{}` | Values to passthrough to the gitlab runner chart: https://repo1.dso.mil/platform-one/big-bang/apps/developer-tools/gitlab-runner.git | | addons.gitlabRunner.postRenderers | list | `[]` | Post Renderers. See docs/postrenders.md | | addons.nexus.enabled | bool | `false` | Toggle deployment of Nexus. | | addons.nexus.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/developer-tools/nexus.git"` | | | addons.nexus.git.path | string | `"./chart"` | | -| addons.nexus.git.tag | string | `"34.1.0-bb.2"` | | +| addons.nexus.git.tag | string | `"34.1.0-bb.4"` | | | addons.nexus.license_key | string | `""` | Base64 encoded license file. | | addons.nexus.ingress.gateway | string | `""` | | | addons.nexus.sso.enabled | bool | `false` | Toggle SAML SSO for NXRM. -- handles SAML SSO, a Client must be configured in Keycloak or IdP -- to complete setup. -- https://support.sonatype.com/hc/en-us/articles/1500000976522-SAML-integration-for-Nexus-Repository-Manager-Pro-3-and-Nexus-IQ-Server-with-Keycloak#h_01EV7CWCYH3YKAPMAHG8XMQ599 | -| addons.nexus.sso.idp_data | object | `{"email":"","firstName":"","groups":"","idpMetadata":"","lastName":"","username":""}` | NXRM SAML SSO Integration data | +| addons.nexus.sso.idp_data | object | `{"email":"","entityId":"","firstName":"","groups":"","idpMetadata":"","lastName":"","username":""}` | NXRM SAML SSO Integration data | | addons.nexus.sso.idp_data.username | string | `""` | IdP Field Mappings -- NXRM username attribute | | addons.nexus.sso.idp_data.firstName | string | `""` | NXRM firstname attribute (optional) | | addons.nexus.sso.idp_data.lastName | string | `""` | NXRM lastname attribute (optional) | | addons.nexus.sso.idp_data.email | string | `""` | NXRM email attribute (optional) | | addons.nexus.sso.idp_data.groups | string | `""` | NXRM groups attribute (optional) | | addons.nexus.sso.idp_data.idpMetadata | string | `""` | IDP SAML Metadata XML as a single line string in single quotes -- this information is public and does not require a secret | -| addons.nexus.sso.role | object | `{"description":"","id":"","name":""}` | NXRM Role | +| addons.nexus.sso.role | list | `[{"description":"","id":"","name":"","privileges":[],"roles":[]}]` | NXRM Role | | addons.nexus.flux | object | `{}` | Flux reconciliation overrides specifically for the Nexus Repository Manager Package | | addons.nexus.values | object | `{}` | Values to passthrough to the nxrm chart: https://repo1.dso.mil/platform-one/big-bang/apps/sandbox/nexus.git | | addons.nexus.postRenderers | list | `[]` | Post Renderers. See docs/postrenders.md | | addons.sonarqube.enabled | bool | `false` | Toggle deployment of SonarQube. | | addons.sonarqube.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/developer-tools/sonarqube.git"` | | | addons.sonarqube.git.path | string | `"./chart"` | | -| addons.sonarqube.git.tag | string | `"9.6.3-bb.8"` | | +| addons.sonarqube.git.tag | string | `"9.6.3-bb.9"` | | | addons.sonarqube.flux | object | `{}` | Flux reconciliation overrides specifically for the Sonarqube Package | | addons.sonarqube.ingress.gateway | string | `""` | | | addons.sonarqube.sso.enabled | bool | `false` | Toggle SAML SSO for SonarQube. Enabling this option will auto-create any required secrets. | @@ -318,14 +319,14 @@ To start using Big Bang, you will need to create your own Big Bang environment t | addons.mattermostoperator.enabled | bool | `false` | | | addons.mattermostoperator.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/collaboration-tools/mattermost-operator.git"` | | | addons.mattermostoperator.git.path | string | `"./chart"` | | -| addons.mattermostoperator.git.tag | string | `"1.15.0-bb.0"` | | +| addons.mattermostoperator.git.tag | string | `"1.16.0-bb.0"` | | | addons.mattermostoperator.flux | object | `{}` | Flux reconciliation overrides specifically for the Mattermost Operator Package | | addons.mattermostoperator.values | object | `{}` | Values to passthrough to the mattermost operator chart: https://repo1.dso.mil/platform-one/big-bang/apps/collaboration-tools/mattermost-operator/-/blob/main/chart/values.yaml | | addons.mattermostoperator.postRenderers | list | `[]` | Post Renderers. See docs/postrenders.md | | addons.mattermost.enabled | bool | `false` | Toggle deployment of Mattermost. | | addons.mattermost.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/collaboration-tools/mattermost.git"` | | | addons.mattermost.git.path | string | `"./chart"` | | -| addons.mattermost.git.tag | string | `"0.2.2-bb.0"` | | +| addons.mattermost.git.tag | string | `"0.2.3-bb.0"` | | | addons.mattermost.flux | object | `{}` | Flux reconciliation overrides specifically for the Mattermost Package | | addons.mattermost.enterprise | object | `{"enabled":false,"license":""}` | Mattermost Enterprise functionality. | | addons.mattermost.enterprise.enabled | bool | `false` | Toggle the Mattermost Enterprise. This must be accompanied by a valid license unless you plan to start a trial post-install. | @@ -362,7 +363,7 @@ To start using Big Bang, you will need to create your own Big Bang environment t | addons.keycloak.enabled | bool | `false` | Toggle deployment of Keycloak. if you enable Keycloak you should uncomment the istio passthrough configurations above istio.ingressGateways.passthrough-ingressgateway and istio.gateways.passthrough | | addons.keycloak.git.repo | string | `"https://repo1.dso.mil/platform-one/big-bang/apps/security-tools/keycloak.git"` | | | addons.keycloak.git.path | string | `"./chart"` | | -| addons.keycloak.git.tag | string | `"11.0.1-bb.8"` | | +| addons.keycloak.git.tag | string | `"11.0.1-bb.9"` | | | addons.keycloak.database.host | string | `""` | Hostname of a pre-existing database to use for Keycloak. Entering connection info will disable the deployment of an internal database and will auto-create any required secrets. | | addons.keycloak.database.type | string | `"postgres"` | Pre-existing database type (e.g. postgres) to use for Keycloak. | | addons.keycloak.database.port | int | `5432` | Port of a pre-existing database to use for Keycloak. |