-
Notifications
You must be signed in to change notification settings - Fork 114
Update docs #526
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
Merged
Merged
Update docs #526
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c3cd656
Docs: remove outdated develop.md
aramprice 4929e54
Docs: Update new stemcell line instructions
aramprice 8becabd
Docs: relocate ci/docs/ to docs/
aramprice 8f66aea
Docs: update publish.md
aramprice 9e69e9d
Docs: update fips.md wording, examples
aramprice 8f7d2a9
Docs: update new_stemcell_line.md
aramprice File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| #@data/values | ||
| --- | ||
|
|
||
| stemcell_details: | ||
| branch: ubuntu-jammy | ||
| major_version: 1 | ||
|
|
||
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,53 @@ | ||
| # FIPS stemcells | ||
|
|
||
| ## access to the fips stemcell buckets | ||
|
|
||
| fips stemcells when published in the pipeline | ||
| will be put in a private bucket called `bosh-core-stemcells-fips` | ||
|
|
||
| if a working groups needs these fips stemcell the can retrieve them with the | ||
| [bosh-io-stemcell](https://github.com/concourse/bosh-io-stemcell-resource) concourse resource =>1.2.1 | ||
| [bosh-io-stemcell](https://github.com/concourse/bosh-io-stemcell-resource) concourse resource => 1.2.1 | ||
|
|
||
| by setting | ||
| ``` | ||
|
|
||
| ```yaml | ||
| resources: | ||
| - name: stemcell | ||
| type: bosh-io-stemcell | ||
| source: | ||
| name: bosh-aws-xen-hvm-ubuntu-jammy-fips-go_agent | ||
| auth: | ||
| access_key: hmac-accesskey | ||
| secret_key: hmac-secretkey | ||
| access_key: ((access_key-credhub_ref)) | ||
| secret_key: ((secret_key-credhub_ref)) | ||
| ``` | ||
|
|
||
| for this you need a service account setup with hmac keys | ||
| https://cloud.google.com/storage/docs/authentication/hmackeys | ||
|
|
||
| ## setup access | ||
| to setup access permissions for the `bosh-core-stemcells-fips` bucket | ||
|
|
||
| setup access permissions for the `bosh-core-stemcells-fips` bucket | ||
|
|
||
| ### working group actions | ||
| a service accunt should be setup in the working group that want to access the fips stemcells. | ||
|
|
||
| a service account should be setup in the working group that want to access the fips stemcells. | ||
| this account should then be enabled with [hmac keys](https://cloud.google.com/storage/docs/authentication/hmackeys) | ||
|
|
||
| #### bucket owner actions | ||
|
|
||
| requirements: | ||
| - [gcloud](https://cloud.google.com/sdk/docs/install) | ||
| - [gsutil](https://cloud.google.com/storage/docs/gsutil_install) | ||
|
|
||
| login to the cloud-foundry-310819 project ` gcloud auth login` | ||
| Login to the `cloud-foundry-310819` GCP project `gcloud auth login` and setup | ||
| access for cross-project buckets. In the example below replace PLACEHOLDER with | ||
| the service account that is created in the previous steps. | ||
| Ex: `test-dev@myproject.iam.gserviceaccount.com` | ||
|
|
||
| setup access for cross project cloud buckets. reference: https://cloud.google.com/dataprep/docs/concepts/gcs-buckets | ||
| replace PLACEHOLDER with the service account that is created in the previous steps for example test-dev@myproject.iam.gserviceaccount.com | ||
| ``` | ||
| gsutil defacl ch -u PLACEHOLDER gs://bosh-core-stemcells-fips | ||
| ```shell | ||
| gsutil defacl ch -u PLACEHOLDER:READER gs://bosh-core-stemcells-fips | ||
| gsutil acl ch -u PLACEHOLDER:READER gs://bosh-core-stemcells-fips | ||
| gsutil -m acl ch -r -u PLACEHOLDER:READER gs://bosh-core-stemcells-fips | ||
| ``` | ||
|
|
||
| Reference: https://cloud.google.com/dataprep/docs/concepts/gcs-buckets | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,40 @@ | ||
| # Creating a new stemcell line | ||
|
|
||
| 1. Create a new branch from the passing commit you want to release from. Use `{os_name}-{os_version}/{major}.x` format for branch name (e.g. `ubuntu-jammy/1.x`). | ||
|
|
||
| `git checkout -b <<BRANCH_NAME>> {commit}` | ||
|
|
||
| 1. Add, commit, and push the new branch. | ||
|
|
||
| 1. Create a new branch from the passing commit you want to release from. Use `ubuntu-${short_name}` format for branch name. | ||
|
|
||
| ```shell | ||
| export short_name="jammy" | ||
|
|
||
| git switch -c ubuntu-${short_name} {commit} | ||
| ``` | ||
|
|
||
| 2. Update `ci/pipelines/vars.yml` with the appropriate values | ||
|
|
||
| ```yaml | ||
| #@data/values | ||
| stemcell_details: | ||
| branch: ubuntu-jammy | ||
| # ... | ||
| blobstore_types: | ||
| - dav | ||
| # ... | ||
| ``` | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| git push origin <<BRANCH_NAME>> | ||
| ``` | ||
|
|
||
| 1. Switch back to master branch | ||
|
|
||
| ``` | ||
| git checkout master | ||
| 3. Update `STEMCELL_LINE` in `ci/configure.sh`: | ||
|
|
||
| ```shell | ||
| STEMCELL_LINE="ubuntu-${short_name}" | ||
| ``` | ||
|
aramprice marked this conversation as resolved.
|
||
|
|
||
| 1. On master, update `ci/{os_name}-{os_version}/configure-aggregated-pipeline.sh` with the new branch details using the previous release branch as an example. Specifically, be sure to update the interpolated variables for the correct branch. For `initial_version`, use the same value of the stemcell produced by the commit in the `master` pipeline (e.g. `2.0.0`). | ||
| 4. Add, commit, and push the new branch. | ||
|
|
||
| ```shell | ||
| git push --set-upstream origin HEAD | ||
| ``` | ||
| ./ci/{os_name}-{os_version}/configure-aggregated-pipeline.sh | ||
| ``` | ||
|
|
||
| 1. Once configured, the stemcell should automatically trigger and create the next minor version of the stemcell (e.g. `2.1.0`). | ||
| 5. Configure the new pipeline: | ||
|
|
||
| ```shell | ||
| ./ci/configure.sh | ||
| ``` | ||
|
|
||
| # References | ||
|
|
||
| * [Stemcell Support Matrix](https://docs.google.com/spreadsheets/d/11LgvmuR-XxXpKB-UVi91FL0nkITGhoB-G1NHPwfnweo/edit) (internal only) | ||
| 6. Once configured, the stemcell pipeline should automatically trigger. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Publish a stemcell | ||
|
|
||
| ## Verify stemcells have built | ||
|
|
||
| The following CI build groups process USN(s), and post a message to the | ||
| `#bosh-private` channel in the | ||
| [Cloud Foundry slack](https://cloudfoundry.slack.com) | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-jammy-builder?group=automatic-triggers | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-noble-builder?group=automatic-triggers | ||
|
|
||
| A USN triggers the stemcell build pipeline to pick up newer packages which | ||
| address the USN(s). Before publishing a new stemcell verify the latest build of | ||
| `aggregate-candidate-stemcells` job for the stemcell line in question: | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-jammy-builder/jobs/aggregate-candidate-stemcells | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-noble-builder/jobs/aggregate-candidate-stemcells | ||
|
|
||
| Look for a successful build triggered by the USN(s). | ||
|
|
||
| In the publisher pipelines: | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-jammy-publisher | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-noble-publisher | ||
|
|
||
| verify that the lite stemcell builds for Google and AWS have been successfully | ||
| triggered by the USN(s). | ||
|
|
||
| ## Publish stemcells | ||
|
|
||
| In order to publish new stemcells, trigger a build of the | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| `publish-ubuntu-${short_name}-1` job: | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-jammy-publisher/jobs/publish-ubuntu-jammy-1 | ||
| - https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-noble-publisher/jobs/publish-ubuntu-noble-1 | ||
|
|
||
| This job will take around 1h to run. When this job is finished, new stemcell | ||
| versions will be available on bosh.io and a GitHub draft release will have been | ||
| created at | ||
| - https://github.com/cloudfoundry/bosh-linux-stemcell-builder/releases. | ||
|
|
||
| Check to see if the draft release has the correct USNs and CVEs, add any extra | ||
| information (see below) to the release notes, and publish the GitHub release. | ||
|
|
||
| Then [Finalize the draft release on GitHub](https://github.com/cloudfoundry/bosh-linux-stemcell-builder/releases) | ||
| - Select the appropriate `Previous Tag` and click "Generate release notes" - | ||
| - Do NOT leave it set to `Auto` as that will result in incorrect release notes. | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| - Scroll to the bottom; cut-and-paste the "What's Changed" section and paste it | ||
| at the top | ||
| - Check the items for correctness; they may have already been published in a | ||
| previous release. Branch merges can confuse GitHub's auto-generated notes. | ||
| - Reword the bullet items to convey what was fixed: | ||
|
|
||
| | old (bad) | new (good) | | ||
| |----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| | ||
| | 🐞 Fix “Cannot connect to the monit daemon.” | Fixed issue with BOSH service-broker tasks failing under heavy usage with error "Cannot connect to the monit daemon." | | ||
| | Installing ethtool in Jammy by @<someone> in | Stemcells now include the networking utility, ethtool, useful for troubleshooting & resolving networking issues. | | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.