You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/administration/codefresh-runner.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ You can obtain an API Key from your [user settings page](https://g.codefresh.io/
45
45
46
46
***Note:** access to the Codefresh CLI is only needed once during the Runner installation. After that, the Runner will authenticate on it own using the details provided. You do NOT need to install the Codefresh CLI on the cluster that is running Codefresh pipelines.*
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.
129
129
130
-
### Inspecting the Manifests before they are installed
130
+
### Inspecting the Manifests Before they are Installed
131
131
132
132
If you want to see what manifests are used by the installation wizard you can supply the `--dry-run` parameter in the installation process.
In the same manner you can list secrets, config-maps, logs, volumes etc. for the Codefresh builds.
219
219
220
-
## Removing the Codefresh runner
220
+
## Removing the Codefresh Runner
221
221
222
222
You can uninstall the Codefresh runner from your cluster by running:
223
223
@@ -239,7 +239,7 @@ Like the installation wizard, you can pass the following options in advance as c
239
239
| kube-config-path | Path to kubeconfig file (default is $HOME/.kube/config) |
240
240
| verbose | Print logs. |
241
241
242
-
## System requirements
242
+
## System Requirements
243
243
244
244
Once installed the runner uses the following pods:
245
245
@@ -271,14 +271,14 @@ Node size and count will depend entirely on how many pipelines you want to be
271
271
272
272
The size of your nodes directly relates to the size required for your pipelines and thus it is dynamic. If you find that only a few larger pipelines require larger nodes you may want to have two Codefresh Runners associated to different node pools.
273
273
274
-
### Storage space
274
+
### Storage Space
275
275
276
276
For the storage space needed by the `dind` pod we suggest:
277
277
278
278
* [Local SSD](https://cloud.google.com/kubernetes-engine/docs/how-to/persistent-volumes/local-ssd) in the case of GCP
279
279
* [EBS](https://aws.amazon.com/ebs/) in the case of Amazon. See also the [notes](#installing-on-aws) about getting caching working.
280
280
281
-
### Networking requirements
281
+
### Networking Requirements
282
282
283
283
* `dind` - this pod will create an internal network in the cluster to run all the pipeline steps
284
284
* `dind` needs outgoing/egress access to Dockerhub and `quay.io`
@@ -300,7 +300,7 @@ codefresh runner upgrade
300
300
301
301
and follow the wizard prompts.
302
302
303
-
## Optional installation of the App Proxy
303
+
## Optional Installation of the App Proxy
304
304
305
305
The App Proxy is an optional component of the runner that once installed:
306
306
@@ -349,7 +349,7 @@ If you have multiple ingress controllers in the Kubernetes cluster you can use t
349
349
By default the app-proxy ingress will use the path `hostname/app-proxy`. You can change that default by using the values file in the installation with the flag `--values values.yaml`. See the `AppProxy` section in the example [values.yaml](https://github.com/codefresh-io/venona/blob/release-1.0/venonactl/example/values-example.yaml).
350
350
351
351
352
-
## Manual installation of Runner components
352
+
## Manual Installation of Runner Components
353
353
354
354
If you don't want to use the wizard, you can also install the components of the runner yourself.
You can fine tune the installation of the runner to better match your environment and cloud provider.
415
415
416
-
### Volume reusage policy
416
+
### Volume Reusage Policy
417
417
418
418
The behavior of how the volumes are reused depends on volume selector configuration.
419
419
`reuseVolumeSelector` option is configurable in runtime environment spec.
@@ -448,7 +448,7 @@ Under `dockerDaemonScheduler.pvcs.dind` block specify `reuseVolumeSelector`:
448
448
codefresh patch re -f runtime.yaml
449
449
```
450
450
451
-
### Custom global environment variables
451
+
### Custom Global Environment Variables
452
452
453
453
You can add your own environment variables in the runtime environment, so that all pipeline steps have access to the same set of external files. A typical
454
454
example would be a shared secret that you want to pass everywhere.
See below is a content of cluster.yaml file. We define separate node pools for dind, engine and other services(like runner, cluster-autoscaler etc).
721
721
@@ -1265,7 +1265,7 @@ Follow these steps to create a Codefresh user with Cluster Admin rights, from th
1265
1265
- Copy the Bearer Token field (combines Access Key and Secret Key)
1266
1266
- Edit your kubeconfig and put the Bearer Token you copied in the `token` field of your user
1267
1267
1268
-
#### Step 3 - Install the runner
1268
+
#### Step 3 - Install the Runner
1269
1269
1270
1270
If you've created your kubeconfig from the Rancher UI, then it will contain an API endpoint that is not reachable internally, from within the cluster. To work around this, we need to tell the runner to instead use Kubernetes' generic internal API endpoint. Also, if you didn't create a Codefresh user in step 2 and your kubeconfig contains your personal user account, then you should also add the `--skip-cluster-integration` option.
0 commit comments