1- # A manual guide to utilizing rings
1+ # A Manual Guide to Managing Rings
22
3- ### Introduction
3+ ## Introduction
44
55This guide presumes that you have set up your ` spk ` project, and installed all
66necessary pipelines created via ` spk project init ` (the lifecycle pipeline),
@@ -15,7 +15,7 @@ request is routed to the `dev` revision of a service. Similarly, if a request is
1515decorated with the ` Ring: prod ` header, the request is routed to the ` prod `
1616revision of a service.
1717
18- ### Service Revisions and Git
18+ ## Service Revisions and Git
1919
2020Service revisions are built and deployed by committing to bedrock.yaml tracked
2121git branches in the form of a ` ring ` . A ` ring ` maps one to one with a service
@@ -59,7 +59,7 @@ the `fabrikam` application - one each for `dev`, `qa`, and `prod`. A user is
5959then able to invoke each revision by making HTTP requests to a single endpoint,
6060decorated with the proper header for each Ring.
6161
62- # ## How deploying service revisions with rings will work
62+ # # How deploying service revisions with rings will work
6363
6464Refer to the `bedrock.yaml` above, with the following rings, and thus git
6565branches :
@@ -70,12 +70,8 @@ branches:
7070- qa
7171` ` `
7272
73- A user wants to add a ring `test-new-homepage`, they first ensure that the git
74- branch exists :
75-
76- - ` git checkout dev -b test-new-homepage`
77-
78- and then invoke the relevant `spk` command to add a `ring` :
73+ A user wants to add a ring `test-new-homepage`, they first create the `ring`, by
74+ invoking the relevant `spk` command :
7975
8076- ` spk ring create test-new-homepage`
8177
@@ -129,14 +125,18 @@ include trigger_
129125A user is then expected to commit and push the `bedrock.yaml`, and the updated
130126pipelines yaml files.
131127
128+ The user can then create the `test-new-homepage` branch, and check it out :
129+
130+ - ` git checkout dev -b test-new-homepage`
131+
132132When a user commits to the `test-new-homepage` branch in the application
133133repository, the `build-update-hld` pipeline will be able to build the container
134134image with the changes to the source code from the `test-new-homepage` branch.
135135It will continue to push the image to Azure Container Registry, and make a pull
136136request against the High Level Definition repository with the newly built
137137container image tag.
138138
139- # ## Status Quo and current work
139+ # # Status Quo and current work
140140
141141At present, `spk` is at version `0.5.4`, which _does_ not implement `ring`
142142management commands - ie adding or removing a `ring` using a _more_ user
@@ -148,12 +148,12 @@ friendly cli, however this work is being tracked in the following github issues:
148148- [Setting a default Ring in SPK](https://github.com/microsoft/bedrock/issues/972)
149149- [Removing a service and a ring from a Cluster](https://github.com/microsoft/bedrock/issues/858)
150150
151- # ## Bridging the gap
151+ # # Bridging the gap
152152
153153While `ring` management features are not yet available in `spk`, we can bridge
154154the gap to using `rings` with a few manual steps for configuration
155155
156- # ### Adding a Ring
156+ # ## Adding a Ring
157157
158158See [this issue](https://github.com/microsoft/bedrock/issues/969) for details on
159159how this feature will be implemented in `spk`.
@@ -205,7 +205,7 @@ variables:
2052056. Change to the new `ring` branch : ` test-new-feature` , and begin to commit, and
206206 push code as you normally would.
207207
208- # ### Deleting a Ring
208+ # ## Deleting a Ring
209209
210210See : [this issue](https://github.com/microsoft/bedrock/issues/971) for details
211211on how this feature will be implemented in `spk`.
0 commit comments