Skip to content

Commit 2f45dea

Browse files
committed
DOC: Improve "deploying services" documentation
skipci
1 parent 8561091 commit 2f45dea

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

docs/source/deploying_services.rst

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,47 +16,49 @@ Deploying a Twined service means the service:
1616
* Will automatically spin down after it has finished answering a question
1717
* Will automatically build and redeploy after a relevant code change (e.g. on push or merge into ``main``)
1818

19+
The main part of the deployment process is deploying the service network infrastructure. Once this is done, services can
20+
be easily added as necessary.
21+
1922
Prerequisites
2023
=============
2124
Twined services are currently deployable to Google Cloud Platform (GCP). You must have "owner" level access to the GCP
2225
project you're deploying to and billing must be set up for it.
2326

2427
Deploying step-by-step
2528
======================
26-
The main part of deployment is deploying the service network infrastructure. Once this is done, services can be easily
27-
added as necessary.
28-
2929
There are three steps to a deployment:
3030

3131
1. Deploy the core infrastructure (e.g. storage bucket, event store, service accounts and roles)
3232
2. Deploy the Kubernetes cluster and partner cloud functions
3333
3. Build and push service docker images to the artifact registry
3434

35-
Deploy core infrastructure
36-
--------------------------
35+
1. Deploy core infrastructure
36+
-----------------------------
3737

38-
- Deploy the ``terraform-octue-twined-core`` Terraform module
38+
- Follow `the instructions <https://github.com/octue/terraform-octue-twined-core>`_ to deploy the resources in the
39+
``terraform-octue-twined-core`` Terraform module
3940
- This only needs to be done once per service network
40-
- Follow the instructions `here <https://github.com/octue/terraform-octue-twined-core>`_
4141

42-
Deploy Kubernetes cluster
43-
-------------------------
42+
2. Deploy Kubernetes cluster
43+
----------------------------
4444

45-
- Deploy the ``terraform-octue-twined-cluster`` Terraform module
45+
- Follow the `instructions <https://github.com/octue/terraform-octue-twined-cluster>`_ to deploy the resources in the
46+
``terraform-octue-twined-cluster`` Terraform module
4647
- This only needs to be done once per service network
47-
- Follow the instructions `here <https://github.com/octue/terraform-octue-twined-cluster>`_
4848

49-
Build and push service docker images
50-
------------------------------------
49+
3. Build and push service docker images
50+
---------------------------------------
5151
Your service is available if its docker image is in the service network's artifact registry repository. We recommend
52-
pushing a new image for each merge into the ``main`` branch, corresponding to a new service revision.
52+
pushing a new image for each merge into the ``main`` branch, corresponding to a new service revision. This can be done
53+
automatically:
5354

54-
- Add the `build-twined-service <https://github.com/octue/workflows/blob/main/.github/workflows/build-twined-service.yml>`_
55-
GitHub Actions workflow to your service's GitHub repository
56-
- This needs to be done for every service you want to deploy
57-
- Follow the instructions `here <https://github.com/octue/workflows#deploying-a-kuberneteskueue-octue-twined-service-revision>`_
55+
- Follow the `instructions <https://github.com/octue/workflows#deploying-a-kuberneteskueue-octue-twined-service-revision>`_
56+
to add the `build-twined-service <https://github.com/octue/workflows/blob/main/.github/workflows/build-twined-service.yml>`_
57+
GitHub Actions workflow to your service's GitHub repository. Set its trigger to merge or push to ``main`` (see example
58+
below)
59+
- This needs to be done **once for every service** you want to deploy
5860
- A live example can be `found here <https://github.com/octue/example-service-kueue/blob/main/.github/workflows/release.yml>`_
59-
including automated pre-deployment testing and release of the code on GitHub
61+
including automated pre-deployment testing and creation of a GitHub release
6062

6163
What next?
6264
==========

0 commit comments

Comments
 (0)