Skip to content

Commit 8becabd

Browse files
committed
Docs: relocate ci/docs/ to docs/
- update publish.md - fix markdown in fips.md
1 parent 4929e54 commit 8becabd

3 files changed

Lines changed: 64 additions & 26 deletions

File tree

ci/docs/publish.md

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

ci/docs/fips.md renamed to docs/fips.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,52 @@
11
# FIPS stemcells
22

33
## access to the fips stemcell buckets
4+
45
fips stemcells when published in the pipeline
56
will be put in a private bucket called `bosh-core-stemcells-fips`
67

78
if a working groups needs these fips stemcell the can retrieve them with the
8-
[bosh-io-stemcell](https://github.com/concourse/bosh-io-stemcell-resource) concourse resource =>1.2.1
9+
[bosh-io-stemcell](https://github.com/concourse/bosh-io-stemcell-resource) concourse resource => 1.2.1
910

1011
by setting
11-
```
12+
13+
```yaml
1214
resources:
1315
- name: stemcell
1416
type: bosh-io-stemcell
1517
source:
1618
name: bosh-aws-xen-hvm-ubuntu-jammy-fips-go_agent
1719
auth:
18-
access_key: hmac-accesskey
19-
secret_key: hmac-secretkey
20+
access_key: hmac-access_key
21+
secret_key: hmac-secret_key
2022
```
23+
2124
for this you need a service account setup with hmac keys
2225
https://cloud.google.com/storage/docs/authentication/hmackeys
2326
2427
## setup access
25-
to setup access permissions for the `bosh-core-stemcells-fips` bucket
28+
29+
setup access permissions for the `bosh-core-stemcells-fips` bucket
2630

2731
### working group actions
28-
a service accunt should be setup in the working group that want to access the fips stemcells.
32+
33+
a service account should be setup in the working group that want to access the fips stemcells.
2934
this account should then be enabled with [hmac keys](https://cloud.google.com/storage/docs/authentication/hmackeys)
3035

3136
#### bucket owner actions
37+
3238
requirements:
3339
- [gcloud](https://cloud.google.com/sdk/docs/install)
3440
- [gsutil](https://cloud.google.com/storage/docs/gsutil_install)
3541

36-
login to the cloud-foundry-310819 project ` gcloud auth login`
42+
Login to the `cloud-foundry-310819` GCP project `gcloud auth login`
3743

3844
setup access for cross project cloud buckets. reference: https://cloud.google.com/dataprep/docs/concepts/gcs-buckets
39-
replace PLACEHOLDER with the service account that is created in the previous steps for example test-dev@myproject.iam.gserviceaccount.com
40-
```
41-
gsutil defacl ch -u PLACEHOLDER gs://bosh-core-stemcells-fips
45+
replace PLACEHOLDER with the service account that is created in the previous steps for example
46+
`test-dev@myproject.iam.gserviceaccount.com`
47+
48+
```shell
49+
gsutil defacl ch -u PLACEHOLDER:READER gs://bosh-core-stemcells-fips
4250
gsutil acl ch -u PLACEHOLDER:READER gs://bosh-core-stemcells-fips
4351
gsutil -m acl ch -r -u PLACEHOLDER:READER gs://bosh-core-stemcells-fips
4452
```
45-

docs/publish.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Publish a stemcell
2+
3+
## Verify stemcell builds
4+
5+
Whenever a USN (Ubuntu Security Notice) is published, a ticket is automatically
6+
created in the community-stemcell board
7+
(https://github.com/orgs/cloudfoundry/projects/4).
8+
There would also be a notification in the #bosh-private channel of the
9+
Cloud Foundry slack.
10+
11+
A USN triggers the stemcell build pipeline, when everything is successfully
12+
built, we can publish the new candidate stemcell version.
13+
Please check the latest build of the aggregate-candidate-stemcells job of the
14+
stemcell line you need to release (aggregate-candidate-stemcells),
15+
you should see a successful build which was triggered by the USN notice.
16+
Then, in the stemcells-publisher pipeline, check if google and aws light
17+
stemcells were successfully built as a result of the USN.
18+
19+
## Publish stemcells
20+
21+
In order to publish new stemcells, trigger a build of the
22+
`publish-ubuntu-${short_name}-1` job:
23+
- https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-jammy-publisher/jobs/publish-ubuntu-jammy-1
24+
- https://bosh.ci.cloudfoundry.org/teams/stemcell/pipelines/ubuntu-noble-publisher/jobs/publish-ubuntu-noble-1
25+
26+
This job will take around 1h to run. When this job is finished, new stemcell
27+
versions will be available on bosh.io and a GitHub draft release will have been
28+
created at
29+
- https://github.com/cloudfoundry/bosh-linux-stemcell-builder/releases.
30+
31+
Check to see if the draft release has the correct USNs and CVEs, add any extra
32+
information (see below) to the release notes, and publish the GitHub release.
33+
34+
Then [Finalize the draft release on GitHub](https://github.com/cloudfoundry/bosh-linux-stemcell-builder/releases)
35+
- Select the appropriate `Previous Tag` and click "Generate release notes" -
36+
- Do NOT leave it set to `Auto` as that will result in incorrect release notes.
37+
- Scroll to the bottom; cut-and-paste the "What's Changed" section and paste it
38+
at the top
39+
- Check the items for correctness; they may have already been published in a
40+
previous release. Branch merges can confuse GitHub's auto-generated notes.
41+
- Reword the bullet items to convey what was fixed:
42+
43+
| old (bad) | new (good) |
44+
|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
45+
| 🐞 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." |
46+
| Installing ethtool in Jammy by @<someone> in | Stemcells now include the networking utility, ethtool, useful for troubleshooting & resolving networking issues. |

0 commit comments

Comments
 (0)