Skip to content

Commit e21ce58

Browse files
authored
Gitops runtime troubleshooting (#1250)
* Create runtime-troubleshooting.md * Add runtime troubleshooting * Update runtime-troubleshooting.md * Update runtime-troubleshooting.md * Add runtime version req to skip token validation Updated skip token validation section with runtime version for this requirement * Update runtime-troubleshooting.md * Update runtime-troubleshooting.md * Update runtime-troubleshooting.md * Fix git token table formatting * Update runtime-troubleshooting.md * Update runtime-troubleshooting.md * Update runtime-troubleshooting.md * Update runtime-troubleshooting.md * Update runtime-troubleshooting.md Added where and when context to errors * Update runtime-troubleshooting.md Updated
1 parent 9138e64 commit e21ce58

File tree

8 files changed

+38
-31
lines changed

8 files changed

+38
-31
lines changed

_data/argohub-home-content.yml

+2
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@
150150
localurl: /gitops/gitops-runtimes/runtime-install-with-existing-argo-cd/
151151
- title: Install GitOps Runtime with new Argo CD
152152
localurl: /gitops/gitops-runtimes/hybrid-gitops-helm-installation/
153+
- title: Troubleshooting Runtime installation
154+
localurl: /gitops/gitops-runtimes/runtime-troubleshooting/
153155

154156

155157
- title: Administration

_data/argohub-nav.yml

+2
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@
7575
url: "/hybrid-gitops-helm-installation"
7676
- title: Configure GitOps Runtime
7777
url: "/runtime-configuration"
78+
- title: Troubleshoot installation
79+
url: "/runtime-troubleshooting"
7880
- title: Runtime values file validation
7981
url: "/gitops-values-yaml-validation"
8082
- title: Ingress and service-mesh access modes

_data/home-content.yml

+2
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@
214214
localurl: /docs/installation/gitops/runtime-install-with-existing-argo-cd/
215215
- title: Install GitOps Runtime with new Argo CD
216216
localurl: /docs/installation/gitops/hybrid-gitops-helm-installation/
217+
- title: Troubleshooting Runtime installation
218+
localurl: /docs/installation/gitops/runtime-troubleshooting/
217219

218220

219221
- title: Administration

_data/nav.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,9 @@
610610
- title: Install GitOps Runtime with existing Argo CD
611611
url: "/runtime-install-with-existing-argo-cd"
612612
- title: Install GitOps Runtime with new Argo CD
613-
url: "/hybrid-gitops-helm-installation"
613+
url: "/hybrid-gitops-helm-installation"
614+
- title: Troubleshoot installation
615+
url: "/runtime-troubleshooting"
614616
- title: On-premises GitOps Runtime
615617
url: "/on-prem-gitops-runtime-install"
616618
- title: Runtime values file validation

_docs/installation/gitops/gitops-values-yaml-validation.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,10 @@ global:
7979
{% endhighlight %}
8080

8181
## Disable validation for custom/fine-grained Git tokens
82-
When using token with custom scopes, or GitHub's fine-grained tokens (currently not officially supported by Codefresh), _skip token validation_ to avoid validation failures during installation.
82+
When using token with custom scopes, or GitHub's fine-grained tokens (currently not officially supported by Codefresh), _for Runtime version v0.18.0 or lower, skip token validation_ to avoid validation failures during installation.
8383

84-
Add the `skipGitPermissionValidation` flag to your `values.yaml` file:
84+
85+
* Add the `skipGitPermissionValidation` flag to your `values.yaml` file:
8586

8687
```yaml
8788
app-proxy:
@@ -105,6 +106,5 @@ where:
105106
* `<version>` is the version of the runtime to install.
106107

107108

108-
## Install first GitOps Runtime in account
109-
If you are installing the first GitOps Runtime in your Codefresh account, follow the installation wizard for guided instructions.
109+
110110

_docs/installation/gitops/runtime-troubleshooting.md

+23-26
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ description: "Review how to resolve issues during Runtime installation"
44
toc: true
55
---
66

7-
7+
## Troubleshooting Runtime installation
8+
This article describes potential issues you may encounter when installing the GitOps Runtime, whether you're using an existing Argo CD instance or setting up a new one.
89

910
## Error: Job has reached the specified backoff limit
10-
Before initiating the installation, Codefresh automatically validates the `values.yaml` file to verify that the supplied values are correct.
11+
This error appears when you copy and run the Install Runtime command in the Runtime Installation wizard.
12+
Before starting the installation, GitOps Cloud automatically validates the `values.yaml` file to ensure the supplied values are correct.
1113

1214
### Possible cause
1315
Validation errors in your `values.yaml` file.
@@ -31,18 +33,18 @@ Validation errors in your `values.yaml` file.
3133

3234

3335
## Error: failed converting helm release <runtime-name> to GitOops;...ISC repo not initialized
34-
This error displayed when you try to Configure the Runtime as Argo CD Application.
36+
This error appears when you try to Configure the Runtime as Argo CD Application in the Runtime Installation wizard.
3537

3638
### Possible cause
37-
The Shared Configuration Repository (`ISC`) has been created but is not yet initialized.
39+
The Shared Configuration Repository (`ISC`) has been created but is not yet initialized.
3840

3941
### Resolution
4042
Wait a few seconds, and try again.
4143

4244

4345
## Runtime timeout errors
44-
One of these errors indicating a timeout:
45-
* `Error: "unable to initialise Codefresh Client", "error": "secrets \"codefresh-token\" not found"`
46+
One of these errors appear in the UI indicating a timeout after completing Runtime installation and configuration in the Runtime Installation wizard:
47+
* `Error: "unable to initialize Codefresh Client", "error": "secrets \"codefresh-token\" not found"`
4648
* For tunnel-based access mode, the `codefresh-tunnel-client` pod fails after installation.
4749
* Pods failed error
4850

@@ -68,45 +70,40 @@ The `--wait` flag in Install Runtime command controls how long the installation
6870

6971

7072
## Invalid Git token error
73+
This error appears in the UI after Runtime installation when all Runtime components including the Application Proxy (app-proxy) are up and running.
7174

7275
### Possible cause
73-
Your token is invalid because of missing scopes
76+
Your token is [invalid because of missing scopes](#check-token-scopes)
7477
OR
75-
You are using a fine-grained token or one with custom scopes
78+
You are using a [fine-grained token or one with custom scopes](#skip-validation-for-fine-grained-github-tokens)
7679

7780
### Resolution
7881

7982
##### Check token scopes
83+
1. Check the scopes for the Runtime token you provided during installation.
84+
If you provided the same token as both the Runtime and user token, make sure the token has the additional scopes required.
85+
1. If needed, generate a new PAT (Personal Access Token) with the correct scopes.
8086

8187
**GitHub Git Runtime token**
82-
{: .table .table-bordered .table-hover}
83-
| Type | Required scopes |
84-
| -------- | ----------------- |
85-
| **Classic** |{::nomarkdown}<ul><li><code class="highlighter-rouge">repo</code></li><li><code class="highlighter-rouge">admin:repo_hook</code></li></ul>{:/}|
86-
|**Fine-grained** (personal or group-based) |{::nomarkdown}<ul><li>Repository access: <code class="highlighter-rouge">All repositories</code> or <code class="highlighter-rouge">Only select repositories</code> including all repos that Argo CD syncs from</li><li>Repository permissions:<ul><li>Administration: <code class="highlighter-rouge">Read and write</code></li><li>Commit statuses: <code class="highlighter-rouge">Read and write</code></li><li>Contents: <code class="highlighter-rouge">Read and write</code></li><li>Metadata: <code class="highlighter-rouge">Read-only</code></li><li>Pull requests: <code class="highlighter-rouge">Read and write</code></li><li>Webhooks: <code class="highlighter-rouge">Read and write</code></li></ul></li></ul>{:/}|
8788

8889
{: .table .table-bordered .table-hover}
8990
| Type | Required scopes |
9091
| -------- | ----------------- |
9192
| **Classic** | {::nomarkdown}<ul><li><code class="highlighter-rouge">repo</code></li><li><code class="highlighter-rouge">admin:repo_hook</code></li></ul>{:/} |
92-
| **Fine-grained** (personal or group-based) | {::nomarkdown}<ul><li>Repository access: <code class="highlighter-rouge">All repositories</code> or <code class="highlighter-rouge">Only select repositories</code> including all repos that Argo CD syncs from
93-
</li><li>Repository permissions:<ul><li>Administration: <code class="highlighter-rouge">Read and write</code></li><li>Commit statuses: <code class="highlighter-rouge">Read and write</code></li><li>Contents: <code class="highlighter-rouge">Read and write</code></li><li>Metadata: <code class="highlighter-rouge">Read-only</code></li><li>Pull requests: <code class="highlighter-rouge">Read and write</code></li><li>Webhooks: <code class="highlighter-rouge">Read and write</code></li></ul></li</ul>{:/} |
93+
| **Fine-grained** (personal or group-based) | {::nomarkdown}<ul><li>Repository access: <code class="highlighter-rouge">All repositories</code> or <code class="highlighter-rouge">Only select repositories</code> including all repos that Argo CD syncs from</li><li>Repository permissions: <ul><li>Administration: <code class="highlighter-rouge">Read and write</code></li><li>Commit statuses: <code class="highlighter-rouge">Read and write</code></li><li>Contents: <code class="highlighter-rouge">Read and write</code></li><li>Metadata: <code class="highlighter-rouge">Read-only</code></li><li>Pull requests: <code class="highlighter-rouge">Read and write</code></li><li>Webhooks: <code class="highlighter-rouge">Read and write</code></li></ul></li></ul>{:/} |
9494

9595

96+
<br>
9697

9798
**GitHub Git user token**
98-
{: .table .table-bordered .table-hover}
99-
| Type | Required scopes |
100-
| ------------ | ----------------- |
101-
| **Classic** |{::nomarkdown}<ul><li><code class="highlighter-rouge">repo</code></li></ul>{:/} |
102-
|**Fine-grained** |{::nomarkdown}<ul><li>Repository access: <code class="highlighter-rouge">All repositories</code> or <code class="highlighter-rouge">Only select repositories</code></li><li>Repository permissions:<ul><li>Contents: <code class="highlighter-rouge">Read and write</code></li><li>Metadata: <code class="highlighter-rouge">Read-only</code></li></ul></li></ul>{:/}|
103-
10499

105100
{: .table .table-bordered .table-hover}
106-
| Type | Required scopes |
101+
| Type | Required scopes |
107102
| -------- | ----------------- |
108103
| **Classic** | {::nomarkdown}<ul><li><code class="highlighter-rouge">repo</code></li><li><code class="highlighter-rouge">admin:repo_hook</code></li></ul>{:/} |
109-
| **Fine-grained** (personal or group-based) | {::nomarkdown}<ul><li>Repository access: <code class="highlighter-rouge">All repositories</code> or <code class="highlighter-rouge">Only select repositories</code> including all repos that Argo CD syncs from</li><li>Repository permissions:<ul><li>Administration: <code class="highlighter-rouge">Read and write</code></li><li>Commit statuses: <code class="highlighter-rouge">Read and write</code></li><li>Contents: <code class="highlighter-rouge">Read and write</code></li><li>Metadata: <code class="highlighter-rouge">Read-only</code></li><li>Pull requests: <code class="highlighter-rouge">Read and write</code></li><li>Webhooks: <code class="highlighter-rouge">Read and write</code></li></ul></li></ul>{:/} |
104+
| **Fine-grained** (personal or group-based) | {::nomarkdown}<ul><li>Repository access: <code class="highlighter-rouge">All repositories</code> or <code class="highlighter-rouge">Only select repositories</code> including all repos that Argo CD syncs from</li><li>Repository permissions: <ul><li>Administration: <code class="highlighter-rouge">Read and write</code></li><li>Commit statuses: <code class="highlighter-rouge">Read and write</code></li><li>Contents: <code class="highlighter-rouge">Read and write</code></li><li>Metadata: <code class="highlighter-rouge">Read-only</code></li><li>Pull requests: <code class="highlighter-rouge">Read and write</code></li><li>Webhooks: <code class="highlighter-rouge">Read and write</code></li></ul></li></ul>{:/} |
105+
106+
110107

111108

112109
<!--- ##### Ensure token formatting
@@ -184,6 +181,6 @@ global:
184181
...
185182
```
186183

187-
188-
## Add Git Source failure
189-
TBD
184+
## Related articles
185+
[Install GitOps Runtime with existing Argo CD]({{site.baseurl}}/docs/installation/gitops/runtime-install-with-existing-argo-cd/)
186+
[Install GitOps Runtime with new Argo CD]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_docs/installation/gitops/runtime-troubleshooting.md

assets/js/src/argohub-redirect-mapping.json

+1
Original file line numberDiff line numberDiff line change
@@ -118,5 +118,6 @@
118118
"/docs/installation/gitops/runtime-argocd-admin-api-token/": "/gitops/gitops-runtimes/runtime-argocd-admin-api-token/",
119119
"/docs/installation/gitops/runtime-install-ingress-service-mesh-access-mode/": "/gitops/gitops-runtimes/runtime-install-ingress-service-mesh-access-mode/",
120120
"/docs/promotions/getting-started/": "/gitops/promotions/getting-started/",
121+
"/docs/installation/gitops/runtime-troubleshooting/": "/gitops/gitops-runtimes/runtime-troubleshooting/",
121122
"/docs/products/promotion-concurrency/": "/gitops/products/promotion-concurrency/"
122123
}

0 commit comments

Comments
 (0)