Skip to content
This repository was archived by the owner on Apr 13, 2020. It is now read-only.

Commit 5209a4a

Browse files
committed
Adding helm chart docs
1 parent 6fc70ea commit 5209a4a

File tree

1 file changed

+68
-2
lines changed

1 file changed

+68
-2
lines changed

guides/project-service-management-guide.md

+68-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ This document describes the workflow for deploying a set of services
2020
configured to sync from the single Materialized Manifest Repositories, and
2121
multiple Project repositories can be pointed to the single High Level
2222
Definition Repository.
23-
- Step 5 can be repeated each time you need to onboard a service to your Bedrock
24-
automated infrastructure.
23+
- Step 5 can be repeated each time you need to onboard a service to your
24+
Bedrxock automated infrastructure.
2525
- Step 6 can be run as many times as required to add a service revision to a
2626
Bedrock project.
2727

@@ -251,6 +251,72 @@ application repositories
251251
**NOTE** `spk service` command documentation can be found
252252
[here](/guides/service-management.md).
253253

254+
#### Helm Configuration for SPK
255+
256+
`spk service create` allows a user to configure a service a number fo ways with
257+
a backing helm chart.
258+
259+
Presently, there are are a number of options for `spk service create` documented
260+
below:
261+
262+
```
263+
-c, --helm-chart-chart <helm-chart> bedrock helm chart name. --helm-chart-* and --helm-config-* are exclusive; you may only use one. (default: "")
264+
-r, --helm-chart-repository <helm-repository> bedrock helm chart repository. --helm-chart-* and --helm-config-* are exclusive; you may only use one. (default: "")
265+
266+
-g, --helm-config-git <helm-git> bedrock helm chart configuration git repository. --helm-chart-* and --helm-config-* are exclusive; you may only use one. (default: "")
267+
-b, --helm-config-branch <helm-branch> bedrock custom helm chart configuration branch. --helm-chart-* and --helm-config-* are exclusive; you may only use one. (default: "")
268+
-p, --helm-config-path <helm-path> bedrock custom helm chart configuration path. --helm-chart-* and --helm-config-* are exclusive; you may only use one. (default: "")
269+
```
270+
271+
As noted by the the documentation text, `helm-chart-*` and `helm-config-*` are
272+
both mutually exclusive configurations ie: you can _only_ use one set of
273+
configurations or the other.
274+
275+
This section intends on documenting the various use cases for both sets of
276+
mutually exclusive configurations.
277+
278+
##### Helm Charts in a well-known Helm Repository
279+
280+
A Helm Repository is a well known set of helm charts conforming to the
281+
[helm repository guidelines](https://helm.sh/docs/topics/chart_repository/).
282+
Perhaps the best known helm repository is the community run
283+
[helm charts repository](https://github.com/helm/charts).
284+
285+
As an `spk` user, if you would like to incorporate helm charts from a well known
286+
public repository, you may simply run `spk` the following `helm-chart`
287+
arguments:
288+
289+
```
290+
spk service create --helm-chart-chart stable/nginx --helm-chart-repository github.com/helm/charts
291+
```
292+
293+
##### Helm Charts in a distinct Git Repository
294+
295+
If your Helm Charts are in their own distinct Git Repository in an Azure DevOps
296+
project, you can use the `helm-config` arguments to configure `spk`:
297+
298+
```
299+
spk service create --helm-config-git https://dev.azure.com/fabrikam/fabrikam-project/_git/fabrikam-helm-charts --helm-config-branch master --helm-path /charts/fabrikam
300+
```
301+
302+
The above invocation presumes that the helm chart repository configured for
303+
`spk` is _different_ from the application repository configured for `spk` usage.
304+
305+
##### Helm Charts in the same repository as the application
306+
307+
If your Helm Charts are intended to be placed adjacent to your application
308+
source (no distinct git repository), you may still use the `helm-config`
309+
arguments to configure `spk`.
310+
311+
If you presume that the `fabrikam-app` repository is the _same_ repository as
312+
the repository of your application sources, then the following invocation will
313+
allow a user to configure a service with helm charts tracked in the _same_
314+
repository.
315+
316+
```
317+
spk service create --helm-config-git https://dev.azure.com/fabrikam/fabrikam-project/_git/fabrikam-app --helm-config-branch master --helm-path /charts/fabrikam
318+
```
319+
254320
#### Creating a Service Revision
255321

256322
- Create and checkout a new git branch

0 commit comments

Comments
 (0)