-
Notifications
You must be signed in to change notification settings - Fork 14
Add documentation on values for the Supply Chain use case #92
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
minmzzhang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the patch method, shall we create patch files for all the optional layer1 applications?
Signed-off-by: Manuel Lorenzo <[email protected]>
05adac7 to
adb4dfc
Compare
This is an option I'm proposing. Creating patches is simple and quick to implement. The downside is that it will require more maintenance if we make a lot of changes to the |
sabre1041
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. A few suggestions
docs/supply-chain.md
Outdated
|
|
||
| ### Setting up the values | ||
|
|
||
| We've seen the components we'll use in this use case. To configure them, we must add (uncomment) these parameters to the `values-hub.yaml` file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does "We've see the components we'll use in this use case" mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am referring to the components described in the previous sections (Main and Supporting Components): RHTAS, RHTPA, ZTWIM, Quay, MCO, and Tekton.
Co-authored-by: Andrew Block <[email protected]>
Co-authored-by: Andrew Block <[email protected]>
Co-authored-by: Andrew Block <[email protected]>
Co-authored-by: Andrew Block <[email protected]>
Co-authored-by: Andrew Block <[email protected]>
Co-authored-by: Andrew Block <[email protected]>
Signed-off-by: Manuel Lorenzo <[email protected]>
| * [Multicloud Object Gateway](https://docs.redhat.com/en/documentation/red_hat_openshift_container_storage/4.8/html/managing_hybrid_and_multicloud_resources/index) is a data service for OpenShift that provides an S3-compatible object storage. In our case, this component is necessary to provide a storage system to Quay. | ||
| * [Red Hat OpenShift Pipelines](https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines/1.20) is a cloud-native CI/CD solution built on the Tekton framework. We will use this product to automate our secure supply chain process, but you could use your own CI/CD solution if one exists. | ||
|
|
||
| ### Setting up the values |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### Setting up the values | |
| ### Defining the values |
|
|
||
| ### Setting up the values | ||
|
|
||
| We've seen the components we'll use in this use case. To configure them, we must add (uncomment) these parameters to the [values-hub.yaml](../values-hub.yaml) file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| We've seen the components we'll use in this use case. To configure them, we must add (uncomment) these parameters to the [values-hub.yaml](../values-hub.yaml) file | |
| To enable this use case, the following parameters should be defined within the [values-hub.yaml](../values-hub.yaml) file |
| argocd.argoproj.io/sync-wave: "-4" # Install after OperatorGroup (-5), before applications | ||
| ``` | ||
|
|
||
| * `Configure the Argo CD applications`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * `Configure the Argo CD applications`: | |
| * Configure the Argo CD _Applications_: |
|
|
||
| We've seen the components we'll use in this use case. To configure them, we must add (uncomment) these parameters to the [values-hub.yaml](../values-hub.yaml) file | ||
|
|
||
| * In the `clustergroup.namespaces` section, create the namespaces for the components by uncommenting the following |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * In the `clustergroup.namespaces` section, create the namespaces for the components by uncommenting the following | |
| * In the `clustergroup.namespaces` section, create the _Namespaces_ for the components by uncommenting the following |
| - openshift-pipelines | ||
| ``` | ||
|
|
||
| * In the `clusterGroup.subscriptions` section, create the subscriptions for the components operators by uncommenting the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * In the `clusterGroup.subscriptions` section, create the subscriptions for the components operators by uncommenting the following: | |
| * In the `clusterGroup.subscriptions` section, create the _Subscriptions_ for the components operators by uncommenting the following: |
| value: quay-admin-password | ||
| ``` | ||
|
|
||
| * `applications.vault.jwt.roles.policies`: In the **Vault** policies section, uncomment the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * `applications.vault.jwt.roles.policies`: In the **Vault** policies section, uncomment the following: | |
| * `applications.vault.jwt.roles.policies`: In the _Vault_ policies section, uncomment the following: |
| - global-secret | ||
| ``` | ||
|
|
||
| * `applications.qtodo.overrides`: In the **qtodo** overrides section, specify the following to source content from the Quay registry instance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * `applications.qtodo.overrides`: In the **qtodo** overrides section, specify the following to source content from the Quay registry instance. | |
| * `applications.qtodo.overrides`: In the _qtodo_ overrides section, specify the following to source content from the Quay registry instance. |
| value: quay-admin-password | ||
| ``` | ||
|
|
||
| The proceeding changes can also be configured by applying [this patch file](./values-patches/supply-chain.patch): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| The proceeding changes can also be configured by applying [this patch file](./values-patches/supply-chain.patch): | |
| To simplify setting the appropriate values for this use case, [this Git patch file](./values-patches/supply-chain.patch) can be used to automate applying the desired configurations by executing the following command from the root of the repository: |
| git apply docs/values-patches/supply-chain.patch | ||
| ``` | ||
|
|
||
| ## Automatic approach |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## Automatic approach | |
| ## Automated Secure Supply Chain Pipeline |
| ```shell | ||
| git apply docs/values-patches/supply-chain.patch | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should be a comment to ensure that the changes are committed (to a feature branch) and published to a remote Git repository
This PR adds documentation on which values should be uncommented in the
values-hub.yamlfile to set up the Supply Chain use case.I've also added a patch file so it can be applied and configured quickly.
Under review