Skip to content

Commit 464c3c5

Browse files
committed
Remove scripts and update documentation about SSDL process
1 parent 8613d00 commit 464c3c5

File tree

5 files changed

+2
-255
lines changed

5 files changed

+2
-255
lines changed

Makefile

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -599,20 +599,6 @@ test-all-in-one: prepare-all-in-one install-credentials ## Test the deploy/all-i
599599
| yq 'select(.kind == "Deployment") | $(CONTAINER_SPEC).args[0]="--atlas-domain=$(ATLAS_DOMAIN)"' \
600600
| kubectl apply -f -
601601

602-
.PHONY: upload-sbom-to-kondukto
603-
upload-sbom-to-kondukto: ## Upload a given SBOM (lite) file to Kondukto
604-
@KONDUKTO_REPO=$(KONDUKTO_REPO) KONDUKTO_BRANCH_PREFIX=$(KONDUKTO_BRANCH_PREFIX) \
605-
./scripts/upload-to-kondukto.sh $(SBOM_JSON_FILE)
606-
607-
.PHONY: augment-sbom
608-
augment-sbom: ## augment the latest SBOM for a given architecture on a given directory
609-
@KONDUKTO_REPO=$(KONDUKTO_REPO) KONDUKTO_BRANCH_PREFIX=$(KONDUKTO_BRANCH_PREFIX) \
610-
./scripts/augment-sbom.sh $(SBOM_JSON_FILE) tmp
611-
612-
.PHONY: store-augmented-sboms
613-
store-augmented-sboms: ## Augment & Store the latest SBOM for a given version & architecture
614-
KONDUKTO_BRANCH_PREFIX=$(KONDUKTO_BRANCH_PREFIX) ./scripts/store-sbom-in-s3.sh $(VERSION) $(TARGET_ARCH) $(SBOMS_DIR)
615-
616602
.PHONY: install-ako-helm
617603
install-ako-helm:
618604
helm repo add mongodb $(HELM_REPO_URL)

docs/dev/release.md

Lines changed: 2 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -136,58 +136,9 @@ Follow the format described in the [release-notes-template.md](../release-notes/
136136
Paste the release notes content approved before the release was started.
137137
Once the image is out, publish the release notes draft as soon as possible.
138138

139-
## Manual SSDLC steps
139+
## SSDLC Process
140140

141-
### Process Overview
142-
143-
The SSDLC process requirements are as follows:
144-
145-
1. Sign our images with a MongoDB owned signature.
146-
1. Produce SBOM (Software Bill Of Materials) for each platform we support (`linux-amd64` and `linux-arm64`).
147-
1. Upload the plain SBOMs to a MongoDB internal Kondukto service instance.
148-
1. Produce the augmented SBOMS, including vulnerability metadata, from using Silkbomb 2.0.
149-
1. Store both sets of SBOM files for internal reference.
150-
151-
The first two steps are semi-automated as documented here. The rest is fully manual.
152-
153-
Right now we are only using **one Kondukto branch per platform**:
154-
- `main-linux-amd64`
155-
- `main-linux-arm64`
156-
157-
This means only the latest version is tracked by Kondukto. Note each upload will replace the SBOM document tracked on each asset group.
158-
159-
For more details about credentials required, to to `MongoDB Confluence` and look for page:
160-
`Kubernetes Atlas Operator SSDLC Compliance Manual`
161-
162-
What follows is a quick reference of the make rules involved, assuming the credential setup is already completed and the process is already familiar.
163-
164-
### Upload SBOMs to Kondukto and Augment SBOMs with Kondukto Scan results
165-
166-
Make sure that you have the credentials configured to handle SBOM artifacts.
167-
Read through the wiki page "Kubernetes Atlas Operator SSDLC Compliance Manual" on how to retrieve them.
168-
169-
Get the SDLC files form the release notes and put them in some local temporary directory (has to be within the repo):
170-
171-
```shell
172-
$ curl -L https://github.com/mongodb/mongodb-atlas-kubernetes/releases/download/v${VERSION}/linux_amd64.sbom.json > temp/linux_amd64.sbom.json
173-
$ curl -L https://github.com/mongodb/mongodb-atlas-kubernetes/releases/download/v${VERSION}/linux_arm64.sbom.json > temp/linux_arm64.sbom.json
174-
```
175-
176-
Then use teh tool to augment them for `Kondukto`:
177-
```shell
178-
$ make augment-sbom SBOM_JSON_FILE="temp/linux_amd64.sbom.json"
179-
$ make augment-sbom SBOM_JSON_FILE="temp/linux_arm64.sbom.json"
180-
```
181-
182-
### Register SBOMs internally
183-
184-
To be able to store SBOMs in S3, you need special credentials.
185-
Please advise the Wiki page "Kubernetes Atlas Operator SSDLC Compliance Manual".
186-
187-
```shell
188-
$ make store-augmented-sboms VERSION=${VERSION} TARGET_ARCH=amd64 SBOMS_DIR=temp
189-
$ make store-augmented-sboms VERSION=${VERSION} TARGET_ARCH=arm64 SBOMS_DIR=temp
190-
```
141+
The manual SSDLC compliance steps previously documented (including the use of make augment-sbom and make store-augmented-sboms) are no longer required as this process is now fully automated. Starting with version 2.10.0, the official Software Bill of Materials (SBOM) files for both linux-amd64 and linux-arm64 are automatically generated and published directly to the GitHub release page. You can find them listed alongside the other release artifacts. For any versions prior to 2.10.0, the historical SBOMs remain available in the internal S3 bucket.
191142

192143
## Synchronize configuration changes with the Helm Charts
193144

scripts/augment-sbom.sh

Lines changed: 0 additions & 62 deletions
This file was deleted.

scripts/store-sbom-in-s3.sh

Lines changed: 0 additions & 71 deletions
This file was deleted.

scripts/upload-to-kondukto.sh

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)