Skip to content

Commit 504a86c

Browse files
reviewed and made small changes
1 parent 4635124 commit 504a86c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

_docs/administration/codefresh-runner.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can obtain an API Key from your [user settings page](https://g.codefresh.io/
4545

4646
***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.*
4747

48-
Then run the wizard with the following command
48+
Then run the wizard with the following command:
4949

5050
```
5151
codefresh runner init
@@ -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

@@ -217,7 +217,7 @@ runner-5d549f8bc5-7h5rc 1/1 Running 0 3
217217
```
218218
In the same manner you can list secrets, config-maps, logs, volumes etc. for the Codefresh builds.
219219
220-
## Removing the Codefresh runner
220+
## Removing the Codefresh Runner
221221
222222
You can uninstall the Codefresh runner from your cluster by running:
223223
@@ -239,7 +239,7 @@ Like the installation wizard, you can pass the following options in advance as c
239239
| kube-config-path | Path to kubeconfig file (default is $HOME/.kube/config) |
240240
| verbose | Print logs. |
241241
242-
## System requirements
242+
## System Requirements
243243
244244
Once installed the runner uses the following pods:
245245
@@ -271,14 +271,14 @@ Node size and count will depend entirely on how many pipelines you want to be
271271
272272
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.
273273
274-
### Storage space
274+
### Storage Space
275275
276276
For the storage space needed by the `dind` pod we suggest:
277277
278278
* [Local SSD](https://cloud.google.com/kubernetes-engine/docs/how-to/persistent-volumes/local-ssd) in the case of GCP
279279
* [EBS](https://aws.amazon.com/ebs/) in the case of Amazon. See also the [notes](#installing-on-aws) about getting caching working.
280280
281-
### Networking requirements
281+
### Networking Requirements
282282
283283
* `dind` - this pod will create an internal network in the cluster to run all the pipeline steps
284284
* `dind` needs outgoing/egress access to Dockerhub and `quay.io`
@@ -300,7 +300,7 @@ codefresh runner upgrade
300300
301301
and follow the wizard prompts.
302302
303-
## Optional installation of the App Proxy
303+
## Optional Installation of the App Proxy
304304
305305
The App Proxy is an optional component of the runner that once installed:
306306
@@ -349,7 +349,7 @@ If you have multiple ingress controllers in the Kubernetes cluster you can use t
349349
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).
350350
351351
352-
## Manual installation of Runner components
352+
## Manual Installation of Runner Components
353353
354354
If you don't want to use the wizard, you can also install the components of the runner yourself.
355355
@@ -370,7 +370,7 @@ codefresh install agent --agent-kube-namespace codefresh --install-runtime
370370
371371
You can then follow the instructions for [using the runner](#using-the-codefresh-runner).
372372
373-
### Installing multiple runtimes with a single agent
373+
### Installing Multiple runtimes with a Single Agent
374374
375375
It is also possible, for advanced users to install a single agent that can manage multiple runtime environments.
376376
@@ -409,11 +409,11 @@ codefresh install runtime --runtime-kube-namespace codefresh-runtime-2
409409
codefresh attach runtime --agent-name $AGENT_NAME --agent-kube-namespace codefresh-agent --runtime-name $RUNTIME_NAME --runtime-kube-namespace codefresh-runtime-2 --restart-agent
410410
```
411411
412-
## Configuration options
412+
## Configuration Options
413413
414414
You can fine tune the installation of the runner to better match your environment and cloud provider.
415415
416-
### Volume reusage policy
416+
### Volume Reusage Policy
417417
418418
The behavior of how the volumes are reused depends on volume selector configuration.
419419
`reuseVolumeSelector` option is configurable in runtime environment spec.
@@ -448,7 +448,7 @@ Under `dockerDaemonScheduler.pvcs.dind` block specify `reuseVolumeSelector`:
448448
codefresh patch re -f runtime.yaml
449449
```
450450

451-
### Custom global environment variables
451+
### Custom Global Environment Variables
452452

453453
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
454454
example would be a shared secret that you want to pass everywhere.
@@ -502,7 +502,7 @@ codefresh patch runtime-environment ivan@acme-ebs.us-west-2.eksctl.io/codefresh-
502502

503503

504504

505-
### Custom volume mounts
505+
### Custom Volume Mounts
506506

507507
You can add your own volume mounts in the runtime environment, so that all pipeline steps have access to the same set of external files. A typical
508508
example of this scenario is when you want to make a set of SSL certificates available to all your pipelines. Rather than manually
@@ -545,7 +545,7 @@ Update your runtime environment with the [patch command](https://codefresh-io.gi
545545
```
546546
codefresh patch runtime-environment ivan@acme-ebs.us-west-2.eksctl.io/codefresh-runtime -f runtime.yaml
547547
```
548-
### Internal registry mirror
548+
### Internal Registry Mirror
549549

550550
You can configure your Codefresh Runner to use an internal registry as a mirror for any container images that are mentioned in your pipelines.
551551

@@ -713,9 +713,9 @@ codefresh patch runtime-environment ivan@acme-ebs.us-west-2.eksctl.io/codefresh-
713713
```
714714

715715

716-
### Installing to EKS with autoscaling
716+
### Installing to EKS with Autoscaling
717717

718-
#### Step 1- EKS Cluster creation
718+
#### Step 1- EKS Cluster Creation
719719

720720
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).
721721

@@ -1265,7 +1265,7 @@ Follow these steps to create a Codefresh user with Cluster Admin rights, from th
12651265
- Copy the Bearer Token field (combines Access Key and Secret Key)
12661266
- Edit your kubeconfig and put the Bearer Token you copied in the `token` field of your user
12671267

1268-
#### Step 3 - Install the runner
1268+
#### Step 3 - Install the Runner
12691269

12701270
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.
12711271

0 commit comments

Comments
 (0)