Skip to content

Commit ef3fa1e

Browse files
authored
Add Helm quickstart to dev doc (#32)
* Update dev docs * Add more instructions for deployment
1 parent 39e4d9e commit ef3fa1e

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

development/README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
11
# Development on OpenShift
22

3+
## Getting Started With Helm
4+
35
This directory contains a Helm chart which can be used to deploy a development version of this app for rapid testing.
46

57
Before you use it, you will need to download & install Helm 3.
68

7-
To use it, move to the `development` directory (i.e. `cd development/`), and deploy using the following Helm command:
9+
If you are not familiar with Helm - how to configure it and run - you can start with this quickstart:
10+
11+
[https://helm.sh/docs/intro/quickstart](https://helm.sh/docs/intro/quickstart)
12+
13+
## Using This Chart
14+
15+
1. Clone the target repo:
16+
17+
```
18+
git clone https://github.com/rht-labs/open-management-portal-git-api
19+
```
20+
21+
2. Change into to the `development` directory:
22+
23+
```
24+
cd open-management-portal-git-api/development
25+
```
26+
27+
3. Deploy using the following Helm command:
828

929
```shell script
1030
helm template . \
@@ -40,4 +60,4 @@ It accepts the following variables
4060
| `templateRepositoryId` | The ID of the GitLab repository which defines a template to use for creating new repos |
4161
| `trustedClientKey` | [Temporary] Used as a placeholder to authenticate client requests, being replaced by validating JWT tokens against the `jwtVerifyPublicKeyLocation` |
4262

43-
This will spin up all of the usual resources that this service needs in production, plus a `BuildConfig` configured to build it from source from the Git repository specified. To trigger this build, use `oc start-build omp-git-api`.
63+
This will spin up all of the usual resources that this service needs in production, plus a `BuildConfig` configured to build it from source from the Git repository specified. To trigger this build, use `oc start-build omp-git-api`.

0 commit comments

Comments
 (0)