Skip to content

Commit 1b08eea

Browse files
NimRegevNimRegev
authored
Update install-codefresh-runner.md (#1054)
* Update install-codefresh-runner.md * Update install-codefresh-runner.md Restructured config section into titles
1 parent ed0f1c1 commit 1b08eea

File tree

1 file changed

+47
-23
lines changed

1 file changed

+47
-23
lines changed

‎_docs/installation/runner/install-codefresh-runner.md

Lines changed: 47 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ The [CLI-based installation and configuration](#cli-based-codefresh-runner-insta
2626
Using spot instances can cause failures in Codefresh pipeline builds as they can be taken down without notice.<br>If you require 100% availability, we do not recommend using spot instances.
2727
2828
After installing the Codefresh Runner, you can:
29-
* View the Runner Agent and its Runtime Environments
30-
* View Runner components and resources
31-
* Configure different aspects of the Runner
32-
29+
* [View Runner components and resources](#runner-components-and-resources)
30+
* [View the Runner Agent and its Runtime Environments](#runner-agents-and-runtime-environments)
31+
* [Configure different aspects of the Runner](#runner-configuration)
3332

3433
## System requirements
3534

@@ -106,7 +105,7 @@ The Runner uses the following pods:
106105

107106
All CNI providers/plugins are compatible with the runner components.
108107

109-
## Codefresh Runner Agents and Runtime Environments
108+
## Runner Agents and Runtime Environments
110109

111110
View Codefresh Runners installed for your account and their status. The Codefresh Runners tab in Pipeline Runtimes displays the list of Agents for the account. Every Agent is attached to one or more Runtime Environments. The API token is the one provided during Runner installation.
112111

@@ -157,29 +156,54 @@ Override the default Runtime Environment for a specific pipeline through the pip
157156

158157

159158

160-
## Codefresh Runner configuration
161-
After you install the Codefresh Runner, there are several options for configuring the Runner. For detailed information, see [Configuration](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#configuration){:target="\_blank"} in ArtifactHub.
159+
## Runner configuration
160+
After you install the Codefresh Runner, use the configuration options to customize the installation for your organization.
161+
For detailed information, see [Configuration](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#configuration){:target="\_blank"} in ArtifactHub.
162+
163+
### Runner volume configuration options
164+
* **Custom volume mounts**
165+
Add custom volumes and volume mounts to the runtime environment for all pipeline steps to have access to the same set of external files.
166+
See [Custom volume mounts](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#custom-volume-mounts){:target="\_blank"}.
167+
* **Volume reuse**
168+
Configure the value of `reuseVolumeSelector` in the runtime environment to define volume reuse behavior.
169+
See [Volume reuse policy](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#volume-reuse-policy){:target="\_blank"}.
170+
171+
* **Volume cleaners**
172+
Manage disk space and prevent out-of-sapce errors for Codefresh pipelines.
173+
See [Volume cleaners](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#volume-cleaners){:target="\_blank"}.
174+
175+
* **EBS volume configuration**
176+
Assign permissions to `dind-volume-provisioner` to create/attach/detach/delete/get EBS volumes.
177+
See [EBS backend](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#ebs-backend-volume-configuration){:target="\_blank"}.
178+
179+
* **Azure Disks volume configuration**
180+
Assign permissions to `dind-volume-provisioner` to create/delete/get Azure disks.
181+
See [Azure Disks backend](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#azure-disks-backend-volume-configuration){:target="\_blank"}.
182+
183+
* **GCE Disks volume configuration**
184+
Assign `ComputeEngine.StorageAdmin` permissions to `dind-volume-provisioner`.
185+
See [GCE Disks backend](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#gce-disks-backend-volume-configuration-in-gke){:target="\_blank"}.
186+
162187

163-
##### Runner volume configuration options
164-
* [Custom volume mounts](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#custom-volume-mounts){:target="\_blank"}
165-
* [Volume reuse policy](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#volume-reuse-policy){:target="\_blank"}
166-
* [Volume cleaners](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#volume-cleaners){:target="\_blank"}
167-
* [EBS backend](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#ebs-backend-volume-configuration){:target="\_blank"}
168-
* [Azure Disks backend](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#azure-disks-backend-volume-configuration){:target="\_blank"}
169-
* [GCE Disks backend](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#gce-disks-backend-volume-configuration-in-gke){:target="\_blank"}
188+
### Runner custom environment variables
189+
Add custom environment variables to the Runtime Environment that all pipeline steps can access.
190+
See [Custom global environment variables](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#custom-global-environment-variables){:target="\_blank"}.
170191

171-
##### Runner custom environment variables
172-
* [Custom global environment variables](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#custom-global-environment-variables){:target="\_blank"}
192+
### Runner rootless DinD
193+
To run the docker daemon as non-root user in `rootless` mode, configure the `dind` image tag.
194+
See [Docker daemon in rootless mode](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#rootless-dind){:target="\_blank"}.
173195

174-
##### Runner rootless DinD
175-
* [Docker daemon in rootless mode](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#rootless-dind){:target="\_blank"}
196+
### Runner ARM builds
197+
Run native ARM64v8 builds with `nodeSelector` or `tolerations` for `dind` pods.
198+
See [Run native ARM builds](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#arm){:target="\_blank"}.
176199

177-
##### Runner ARM builds
178-
* [Run native ARM builds](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#arm){:target="\_blank"}
200+
### Runner on OpenShift
201+
Install Runner on OpenShift by configuring `values.yaml`.
202+
See [Install Runner on OpenShift](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#openshift){:target="\_blank"}.
179203

180-
##### Runner installation
181-
* [Install Runner on OpenShift](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#openshift){:target="\_blank"}
182-
* [Agentless install mode for on-premises](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#on-premise){:target="\_blank"}
204+
### Runner in Agentless mode
205+
For on-premises installations, install Runner in `agentless` mode.
206+
See [Agentless install mode for on-premises](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime#on-premise){:target="\_blank"}.
183207

184208
## Runtime Environment specifications
185209

0 commit comments

Comments
 (0)