Replace Helm Install Instructions to use our OCI Based Helm Charts#2541
Merged
Weltraumschaf merged 2 commits intosecureCodeBox:mainfrom Jun 27, 2024
Merged
Conversation
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
J12934
added
enhancement
✅ Deploy Preview for docs-securecodebox ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Member
Author
|
With this I'd like to publish this Discussion / Announcement / Pinned Issue to communicate this with our users: Let me know if this is clear / needs tweaks :) With the secureCodeBox 4.6.0 release, we are transitioning our installation instructions from the old What Will Happen?
What Steps Are Required by Users:You'll need to switch the source of your Helm charts to point to the OCI registry. This process is straightforward. When using Helm via the CLI / CI: # Before
helm --namespace securecodebox-system install securecodebox-operator secureCodeBox/operator
# After
helm --namespace securecodebox-system install securecodebox-operator oci://ghcr.io/securecodebox/helm/operatorExisting releases that have been installed using the # Prior installation:
helm upgrade --install nmap secureCodeBox/nmap --version 4.5.0
# To switch the same Helm release to OCI, simply install the release with the same name from OCI:
helm upgrade --install nmap oci://ghcr.io/securecodebox/helm/nmap --version 4.5.0Both ArgoCD and Flux also support OCI Helm charts. Why Are We Doing This:
|
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
Weltraumschaf
approved these changes
Jun 27, 2024
Member
|
@J12934 seems there are still some references to the old registry: git g 'helm .* secureCodeBox/'
auto-discovery/cloud-aws/.helm-docs.gotmpl
132:helm upgrade --install {{ template "chart.name" . }} secureCodeBox/{{ template "chart.name" . }} --set="config.aws.queueUrl=${SQS_QUEUE_URL}" --set="config.aws.region=${AWS_REGION}"
auto-discovery/cloud-aws/README.md
152:helm upgrade --install auto-discovery-cloud-aws secureCodeBox/auto-discovery-cloud-aws --set="config.aws.queueUrl=${SQS_QUEUE_URL}" --set="config.aws.region=${AWS_REGION}"
auto-discovery/cloud-aws/docs/README.ArtifactHub.md
144:helm upgrade --install auto-discovery-cloud-aws secureCodeBox/auto-discovery-cloud-aws --set="config.aws.queueUrl=${SQS_QUEUE_URL}" --set="config.aws.region=${AWS_REGION}"
bin/install.sh
121: if [[ $(helm -n "$SCB_SYSTEM_NAMESPACE" upgrade --install securecodebox-operator secureCodeBox/operator) ]]; then
documentation/blog/2022-01-18-log4shell.md
260:Most scanner helm charts in the secureCodeBox come with cascading rules by default. E.g. the [rule used to trigger the nmap port scans on amass findings](https://github.com/secureCodeBox/secureCodeBox/blob/main/scanners/nmap/cascading-rules/hostscan.yaml) is included by default in the nmap helm chart GitHub. With the nuclei cascading rule we wanted to have more control over the configuration of the automatically created cascaded scans so we disabled the cascading rules included by default in the helm chart (`helm install nuclei secureCodeBox/nuclei --set="cascadingRules.enabled=false"`) and created our own, incorporating our custom nuclei configuration described above. The rule then looked like the following (reusing the ConfigMap created in the example above):
documentation/docs/11-telemetry.md
28:helm install securecodebox-operator secureCodeBox/operator --set="telemetryEnabled=false"
documentation/docs/architecture/09_architecture_decisions/adr_0012.md
20:Currently all custom resources for the secureCodeBox are isolated into the namespace they are installed from. If you start a scan of type nmap in namespace `demo-one` you'll have to have the `ScanType` (and the corresponding `ParseDefinition`) nmap installed in `demo-one`. This is usually not a big issue as installing a `ScanType` is pretty easy (`helm install nmap secureCodeBox/nmap --namespace demo-one`).
documentation/docs/auto-discovery/installation.md
17:helm install --namespace securecodebox-system auto-discovery-kubernetes secureCodeBox/auto-discovery-kubernetes
documentation/docs/contributing/local-deployment.md
67:securecodebox$ helm --namespace securecodebox-system upgrade --install securecodebox-operator secureCodeBox/operator
documentation/docs/getting-started/first-scans.md
20:helm install nmap secureCodeBox/nmap
documentation/docs/getting-started/troubleshooting.md
27:helm upgrade --install nmap securecodebox/nmap
29:helm upgrade --install nmap secureCodeBox/nmap/
31:helm upgrade --install nmap secureCodeBox/nmap
48:helm upgrade --install nmap secureCodeBox/nmap
documentation/docs/getting-started/uninstallation.md
15:If you want to uninstall specific scanners or hooks you can delete them via `helm`. For example if you installed nmap using `helm install nmap secureCodeBox/nmap` you can delete nmap like this:
documentation/docs/how-tos/hooks.md
116:helm upgrade --install ufh2 secureCodeBox/update-field-hook --set hook.priority="1" --set attribute.name="category" --set attribute.value="second-hook"
213:helm upgrade --install ufh2 secureCodeBox/update-field-hook --set hook.labels.securecodebox="rocks" --set attribute.name="category" --set attribute.value="second-hook"
documentation/docs/how-tos/persistence-storage.md
281:helm --namespace securecodebox-system upgrade --install securecodebox-operator secureCodeBox/operator
288:helm --namespace elastic upgrade --install nmap secureCodeBox/nmap
289:helm --namespace elastic upgrade --install persistence-elastic secureCodeBox/persistence-elastic
364: helm upgrade --install persistence-defectdojo secureCodeBox/persistence-defectdojo \
operator/.helm-docs.gotmpl
48:helm install securecodebox-operator secureCodeBox/operator
operator/README.md
69:helm install securecodebox-operator secureCodeBox/operator
operator/docs/README.ArtifactHub.md
74:helm install securecodebox-operator secureCodeBox/operator
resources/ascii/scb-first-start.cast
391:[30.15912299999992,"o","\u001b]2;helm install nmap secureCodeBox/nmap\u0007"]
resources/ascii/scb-first-start.svg
...
scanners/nikto/examples/demo-juice-shop/README.md
12:helm upgrade --install juice-shop secureCodeBox/juice-shop --waitgit g 'https://charts.securecodebox.io'
github/workflows/helm-charts-release.yaml
23: HELM_REGISTRY: https://charts.securecodebox.io
auto-discovery/kubernetes/demo/juice-shop.yaml
68: repository: https://charts.securecodebox.io
bin/install.sh
314:helm repo add secureCodeBox https://charts.securecodebox.io
documentation/docs/contributing/local-deployment.md
63:securecodebox$ helm repo add secureCodeBox https://charts.securecodebox.io
documentation/docs/getting-started/troubleshooting.md
22:helm repo add secureCodeBox https://charts.securecodebox.io
documentation/docs/how-tos/persistence-storage.md
153:helm repo add secureCodeBox https://charts.securecodebox.io
operator/.helm-docs.gotmpl
44:helm repo add secureCodeBox https://charts.securecodebox.io
operator/README.md
65:helm repo add secureCodeBox https://charts.securecodebox.io
operator/docs/README.ArtifactHub.md
70:helm repo add secureCodeBox https://charts.securecodebox.io
resources/ascii/scb-first-start.cast
105:[9.283162,"o","\u001b]2;helm repo add secureCodeBox https://charts.securecodebox.io\u0007"]
resources/ascii/scb-first-start.svg
... |
4 tasks
Member
Author
|
@Weltraumschaf good find. Used a simpler search which missed a bunch. Should be fixed with: #2543 |
Member
|
@J12934 If you're interested in the |
Member
@J12934 Please make a new PR with a draft post. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Replaces default install instructions across the repo with OCI install instructions
Checklist