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
* Update create CI pipelineSeparated sections common to Git and UI, and added new section for UI pipeline creation* Update quick startChanged title of verify requirements to prepare for runtime install* wip* Update requirements for runtime and troubleshootingCompleted quick start ci pipeline, and updated runtime requirements, added new troubleshooting topic* Update troubleshooting.md
* `<docker-registry-name>` is the Docker Registry for which to create the secret.
75
+
* `<docker-registry-username>` and <docker-registry-password> are your username and password authentication credentials.
76
+
* `<docker-registry-email>` is the ???.
77
+
64
78
### Git: Create CI pipeline
79
+
Create a CI pipeline via Git. Make sure you have your personal Git token and the secret for the Docker Registry before you start.
80
+
81
+
#### Before you begin
82
+
1. Create a personal Git token
83
+
1. Create the Docker Registry secret
84
+
1. Fork the repo, `<repo_name>` to work with the quick start micro service application
65
85
66
86
#### Download and commit CI pipeline resource files
67
87
The basic CI pipeline comprises resource files that you must download and then commit to the Git repository. For the purposes of the quick start, you will commit them to the Git repo you selected or created during runtime installation.
@@ -70,16 +90,10 @@ The basic CI pipeline comprises resource files that you must download and then c
1. Save and commit to the `resource_<runtime-name>` folder in the `<runtime-name>-gitsource` repo that was created during runtime installation.
93
+
1. Save and commit to the `resource_<runtime-name>` folder in the `<runtime-name>_git.source` repo that was created during runtime installation.
74
94
CSDP syncs these resource definitions to your cluster, and create the resources in the cluster.
75
95
1. In the CSDP UI, view the newly created pipeline in [Pipelines]((https://g.codefresh.io/2.0/pipelines){:target="\_blank"}).
76
96
77
-
78
-
79
-
80
-
#### Set up `dockerconfig.json`
81
-
TBD
82
-
83
97
#### Configure pipeline with demo micro service application
84
98
85
99
1. Fork the repository:??
@@ -116,7 +130,7 @@ TBD
116
130
117
131
118
132
#### Trigger an event for the CI pipeline
119
-
To complete the CI pipeline, trigger an event that runs the pipeline.
133
+
To complete the CI pipeline, trigger an event that runs the pipeline.
120
134
121
135
1. Update the `readme.md` file in the root of the Git repo and commit the changes.
122
136
1. Now navigate to the simple-ci pipeline and see that new workflow has been created.
@@ -126,7 +140,75 @@ To complete the CI pipeline, trigger an event that runs the pipeline.
126
140
* Builds the image
127
141
* Pushes the image to your Docker Hub
128
142
* Updates CSDP with the image information
129
-
1. In the CSDP UI, go to Images to view the image.
143
+
1. In the CSDP UI, go to[Images]((https://g.codefresh.io/2.0/images){:target="\_blank"}).
130
144
131
145
146
+
### CSDP: Create a CI pipeline with Create Pipeline wizard
147
+
Use our pipeline creation wizard to create the CI pipeline. Make sure you have your personal Git token and the secret for the Docker Registry before you start.
132
148
149
+
#### Before you begin
150
+
1. Create a personal Git token
151
+
1. Create the Docker Registry secret
152
+
153
+
#### Create the pipeline
154
+
1. In the CSDP UI, go to [Pipelines]((https://g.codefresh.io/2.0/pipelines){:target="\_blank"}).
Review and confirm that your deployment conforms to the minimum requirements for installing CSDP. See[system requirements]({{site.baseurl}}/docs/runtime/requirements).
10
+
**New installation**
11
+
If this is your first CSDP installation, review and confirm that your deployment conforms to the minimum requirements for installing CSDP. See[system requirements]({{site.baseurl}}/docs/runtime/requirements).
12
+
13
+
**Existing installation**
14
+
15
+
If you already have a runtime installation on your cluster, you have two options:
16
+
1. To install on the same cluster, first uninstall the existing runtime. Currently, you can install a single runtime per cluster.
17
+
1. Install on a different cluster, verifying that you meet minimum requirements.
18
+
19
+
**Uninstallation tips for existing runtimes**
20
+
* Before you run uninstall from the CSDP UI or`cf runtime <name> uninstall` from the CLI, delete all CSDP-related namespaces.
21
+
* If the namespace is frozen in the Terminating status, it could be that the namespace has resources with finalizers that prevents them from being deleted.
22
+
Here's how you to remove finalizers using`k9s`:
23
+
* In the`applications` view, do the following for each application:
24
+
* Hit`e` to edit the YAML.
25
+
* Scroll down to the section entitled`finalizers`.
26
+
* Move cursor to the line with the finalizer definition, and then hit`dd` to delete the line.
Copy file name to clipboardExpand all lines: _docs/runtime/installation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,12 +57,12 @@ To install a CSDP runtime, you can either pass the flags in the runtime install
57
57
58
58
**Ingress host**
59
59
60
-
The IP address/host name/FQDN of the ingress controller component.
60
+
The IP address orhost name of the ingress controller component.
61
61
62
62
63
63
**Codefresh demo resources**
64
64
65
-
Optional. Install demo pipelines to use as a starting point to create your own pipelines.
65
+
Optional. Install demo pipelines to use as a starting point to create your own pipelines. We recommend installing the demo resources as these are used in our quick start tutorials.
The requirements listed are the**_minimum_** requirements for CSDP (Codefresh Software Developement Platform).
10
10
11
-
###Kubernetes cluster
11
+
###Kubernetes cluster requirements
12
+
This section lists cluster requirements.
13
+
14
+
####Cluster version
12
15
Kubernetes cluster version 1.20, without Argo Project components
13
16
>In the documentation, Kubernetes and K8s are used interchangeably.
14
17
15
-
###Ingress controller
18
+
####Ingress controller
16
19
Configure your Kubernetes cluster with an Ingress controller component that is exposed from the cluster. For detailed information, see the[Kubernetes documentation on ingress controllers](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/).
17
20
18
-
Here are quick tips to configure ingress controllers in common cluster deployments:
Verify that the ingress controller has a valid external IP address:
23
+
28
24
29
-
**Eks**: Should show a valid external IP when running`kubectl get svc ingress-nginx-controller -n ingress-nginx`. Note this down as you will need this when you install the runtime.
30
-
**K3d**: Should show a valid external IP when running`kubectl get svc traefik -n kube-system`
31
-
**Docker desktop**: Should show`localhost` as the external IP when running`kubectl get svc ingress-nginx-controller -n ingress-nginx`
32
-
33
-
###Default`IngressClass`
25
+
####Default`IngressClass`
34
26
The`IngressClass` resource, or any one of them if you have more than one, must be tagged as the default.
35
27
36
28
To tag an`IngressClass` resource as the default, add this`ingressclass.kubernetes.io/is-default-class` annotation with the value of`true` to the resource.
@@ -43,11 +35,11 @@ To tag an `IngressClass` resource as the default, add this `ingressclass.kuberne
This section lists the requirements for Git installation repositories.
57
+
58
+
#### Git installation repo
59
+
If you are using an existing repo, make sure it is empty.
60
+
61
+
#### Git token
62
+
CSDP requires a GitHub Personal Access Token for runtime installation.
63
+
To create a Git token, see [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
####Pre-installation checks or runtime collision check failed
11
+
12
+
**Possible cause**
13
+
You have Argo Project components from other installations in your cluster.
14
+
15
+
**Possible actions**
16
+
1. Uninstall the CSDP runtime.
17
+
1. Remove the Argo Project components from your cluster.
18
+
1. Reinstall the CSDP runtime.
19
+
20
+
####Pre installation error: please upgrade to the latest cli version: v<number>
21
+
22
+
23
+
####Failed to bootstrap repository: authentication required
24
+
25
+
####Failed adding git integration <...> 404 not found
26
+
27
+
**Possible cause**
28
+
Another process is probably occupying the address you provided as your`ingress-host`.
29
+
30
+
**Possible actions**
31
+
* Terminate the process to free up the address.
32
+
33
+
####Timeout error, either for applications or while waiting for the installation to complete
34
+
**Possible cause**
35
+
Cron-executer has identified that not all your applications are synced and healthy.
36
+
CSDP runtime installation syncs app status at 10-minute intervals. The timeout occurs if after the last status check, at least one application is either not synced or healthy.
37
+
38
+
**Possible actions**
39
+
Without terminating the runtime install, do the following steps:
40
+
41
+
1. In the Argo CD UI, check the status of your apps:
42
+
* Port forward your argo-cd server pod (use default 8080 ports).
43
+
* Access it via`localhost:8080` with the Username`admin`, and Password which is the decoded`argocd-initial-admin-secret` in your cluster.
44
+
With`k9s`, in the`secrets` view, press`x`.
45
+
1. If all apps are perfectly synced and healthy, check the logs of the cron-executor service.
46
+
1. If the logs don't show a cause for the error, try freeing up resources:
47
+
* Free up memory with` docker system prune -a --volumes`.
48
+
* Increase the resources allocated to your cluster.