UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects

Add doc objectstorage

Merged Kavitha Thulasiraman requested to merge add-doc-objectstorage into master
All threads resolved!
Compare and Show latest version
1 file
+ 6
8
Compare changes
  • Side-by-side
  • Inline
@@ -2,7 +2,7 @@
If the package you are integrating connects to object storage (e.g. S3 buckets), you will need to follow the instructions below to integrate this feature into Big Bang.
In BigBang MinIO is a consistent, performant and scalable object store for the cloud strategies. Minio is Kubernetes-native by design and is S3 compatible.
In BigBang MinIO is a consistent, performant and scalable object store for the cloud strategies. Minio is Kubernetes-native by design and provides S3 compatible endpoints.
## Prerequisites
@@ -12,7 +12,7 @@ Addon Minio is enabled at the BigBang level. Alternatively, you have (1) an exis
There are currently 2 typical ways in bigbang that packages connect to object storage.
1. Package charts accept values for host, user, pass, etc and the chart makes the necessary secret, configmap etc.
1. Package charts accept values for endpoint, accessKey, bucket values, etc and the chart makes the necessary secret, configmap etc.
2. Package chart accepts a secret name where all the object storage connection info is defined. In these cases we make the secret in the BB chart.
@@ -56,11 +56,11 @@ Add objectStorage values for the package in bigbang/chart/values.yaml
iamProfile: ""
```
**Packages connecting to a pre-existing object storage.**
**Options for packages connecting to a pre-existing object storage.**
1. Package charts accept values for host, user, pass, etc and the chart makes the necessary secret, configmap etc...
1. Package charts accept values for endpoint, accessKey, bucket values, etc. and the chart makes the necessary secret, configmap etc...
- add a conditional statement to `bigbang/chart/templates/<package>/values` that will check if the object storage values exist and creates the necessary <TODO> values.
- add a conditional statement to `bigbang/chart/templates/<package>/values` that will check if the object storage values exist and creates the necessary object storage values.
If object storage values are present, then the internal object storage is disabled by setting `enabled: false` and the endpoint, accessKey, accessSecret, and bucket values are set.
@@ -79,8 +79,6 @@ task-runner:
Example: [GitLab](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/10d43bea9351b91dfc6f14d3b0c2b2a60fe60c6a/chart/templates/gitlab/values.yaml#L49)
**Packages connecting to a pre-existing object storage**
2. Package chart accepts a secret name where all the object storage connection info is defined. In these cases we make the secret in the BB chart.
- add conditional statement in `chart/templates/<package>/values.yaml` to add values for object storage secret, if object storage values exist. Otherwise the minio cluster is used.
@@ -102,7 +100,7 @@ minio:
{{- end }}
```
Example: [GitLab secret-objectstore.yaml](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/chart/templates/gitlab/secret-objectstore.yaml)
Example: [Mattermost secret-objectstore.yaml](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/chart/templates/mattermost/mattermost/secret-objectstore.yaml)
## Validation
Loading