Skip to content

Commit f40b3b4

Browse files
added installation via helm section (codefresh-io#275)
* added installation via helm section * added parenthesis * fixed title * fixed link * small changes
1 parent ea28d85 commit f40b3b4

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

_docs/administration/codefresh-runner.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To use the Codefresh runner the following is required:
2929

3030
The runner can be installed from any workstation or laptop with access (i.e. via `kubectl`) to the Kubernetes cluster running Codefresh builds. The Codefresh runner will authenticate to your Codefresh account by using the Codefresh CLI token.
3131

32-
## Installation with the quick-start wizard
32+
## Installation with the Quick-start Wizard
3333

3434
Install the Codefresh CLI
3535
```
@@ -88,7 +88,7 @@ codefresh runner info
8888

8989
During installation you can see which API token will be used by the runner (if you don't provide one). The printed token is used by the runner to talk to the Codefresh platform carrying permissions that allow the runner to run pipelines. If you save the token, it can later be used to restore the runner's permissions without creating a new runner installation, if the deployment is deleted.
9090

91-
### Customizing the wizard installation
91+
### Customizing the Wizard Installation
9292

9393
You can customize the wizard installation by passing your own values in the `init` command.
9494
For example you can specify the runtime to be used in advance with:
@@ -127,7 +127,7 @@ codefresh runner init --values values.yaml
127127

128128
You can use [this example](https://github.com/codefresh-io/venona/blob/release-1.0/venonactl/example/values-example.yaml) as a starting point for your values file.
129129

130-
### Inspecting the manifests before they are installed
130+
### Inspecting the Manifests before they are installed
131131

132132
If you want to see what manifests are used by the installation wizard you can supply the `--dry-run` parameter in the installation process.
133133

@@ -140,6 +140,31 @@ used by the installer will be instead saved locally in a folder `./codefresh_man
140140

141141
You can then inspect the manifests locally or edit/apply them manually if you wish.
142142

143+
## Installing Codefresh Runner with Helm
144+
145+
To install the Codefresh Runner using Helm, follow these steps:
146+
147+
1. Download the Codefresh CLI and authenticate it with your Codefresh account. Click [here](https://codefresh-io.github.io/cli/getting-started/) for more detailed instructions.
148+
2. Run the following command to create all of the necessary entities in Codefresh:
149+
150+
```
151+
codefresh runner init --generate-helm-values-file
152+
```
153+
154+
* This will not install anything on your cluster, except for running cluster acceptance tests, (which may be skipped using the `--skip-cluster-test` option).
155+
* This command will also generate a `generated_values.yaml` file in your current directory, which you will need to provide to the `helm install` command later.
156+
3. Now run the following to complete the installation:
157+
158+
```
159+
helm repo add cf-runtime https://h.cfcr.io/codefresh-inc/runtime
160+
161+
helm install cf-runtime cf-runtime/cf-runtime -f ./generated_values.yaml --create-namespace --namespace codefresh
162+
```
163+
4. At this point you should have a working Codefresh Runner. You can verify the installation by running:
164+
```
165+
codefresh runner execute-test-pipeline --runtime-name <runtime-name>
166+
```
167+
143168
## Using the Codefresh Runner
144169
145170

_docs/whats-new/whats-new.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ toc: true
1515

1616
### May 2021
1717

18+
- Installing Codefresh Runner with Helm - [documentation]({{site.baseurl}}/docs/administration/codefresh-runner/#installing-codefresh-runner-with-helm)
1819
- Codecov Integration - [documentation]({{site.baseurl}}/docs/integrations/codecov-integration/)
1920
- Dynamic preview environments - [documentation]({{site.baseurl}}/docs/ci-cd-guides/preview-environments/)
2021
- Tag policy for transforming a docker tag in lowercase or not - [documentation]({{site.baseurl}}/docs/codefresh-yaml/steps/build/#fields)

0 commit comments

Comments
 (0)