Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Support Article Migration#673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
ThatAmatoGuy merged 27 commits intomasterfromsupport-kb-migration
May 4, 2023
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
Show all changes
27 commits
Select commitHold shift + click to select a range
aff9b78
intial article migration
ThatAmatoGuyApr 14, 2023
78606c0
Merge branch 'master' into support-kb-migration
ThatAmatoGuyApr 18, 2023
cffc87a
Auto Update Article List
ThatAmatoGuyApr 18, 2023
06785a0
Merge branch 'master' into support-kb-migration
ThatAmatoGuyApr 19, 2023
de8225b
added template font matter
ThatAmatoGuyApr 19, 2023
1f1f3ba
Updated Font Matter to Docs
ThatAmatoGuyApr 20, 2023
8fb9bb2
update home content to show troubleshooting
ThatAmatoGuyApr 20, 2023
62f9738
formatting and verify links
ThatAmatoGuyApr 21, 2023
c612b2b
Updating formating and links
ThatAmatoGuyApr 24, 2023
7e5294c
Merge branch 'master' into support-kb-migration
ThatAmatoGuyApr 24, 2023
db0a3a3
updating formating, links, and images
ThatAmatoGuyApr 24, 2023
d911b38
finished updating link, formating, and images
ThatAmatoGuyApr 25, 2023
a0b7f9d
update paths to check
ThatAmatoGuyApr 25, 2023
1589daa
updating page auto-generated links
ThatAmatoGuyApr 26, 2023
defd11c
updated URLs to point to the correct kb articles
ThatAmatoGuyApr 26, 2023
7b10c2b
testing fix for images
ThatAmatoGuyApr 27, 2023
aa97cd0
updating image URLs
ThatAmatoGuyApr 27, 2023
f0bb685
update with Sasha feedback
ThatAmatoGuyApr 27, 2023
7eeb5ab
Update build-step-no-such-file-or-directory.md
a-mankinenkoApr 28, 2023
eb94ec3
updated articles per review
ThatAmatoGuyMay 1, 2023
f5630a0
Merge branch 'master' into support-kb-migration
ThatAmatoGuyMay 2, 2023
b2988ea
update variables url for kb
ThatAmatoGuyMay 2, 2023
c950c8a
reorg items to include how to
ThatAmatoGuyMay 2, 2023
6736230
updated URLs to new location
ThatAmatoGuyMay 2, 2023
54e9dfb
updated metadata and reorg docs
ThatAmatoGuyMay 2, 2023
3119939
updated validation checks
ThatAmatoGuyMay 2, 2023
3ad9e12
Update nav.yml
NimRegevMay 4, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions_config.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,3 +144,5 @@ compress_html:
startings: [head, body]
ignore:
envs: development

kb-cat: [Pipelines, Workflows, Ops, Artifacts & Insights, Settings, Runtimes, On-Prem, API, CLI, General]
13 changes: 12 additions & 1 deletion_data/home-content.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -296,5 +296,16 @@




- title: "Knowledge Base"
icon: images/home-icons/troubleshooting.svg
url: ''
links:
- title: Common Issues
localurl: /docs/kb/common-issues
- title: How To's
localurl: /docs/kb/how-to
- title: Troubleshooting
localurl: /docs/kb/troubleshooting
- title: Codefresh SLA Definitions
localurl: /docs/kb/codefresh-sla-definitions

58 changes: 8 additions & 50 deletions_data/nav.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -618,59 +618,17 @@
- title: ARM architecture support
url: "/arm-support"

- title:Troubleshooting
url: "/troubleshooting"
- title:Knowledge Base
url: "/kb"
pages:
- title: Common Issues
url: "/common-issues"
sub-pages:
- title: Can't find your organization repositories
url: "/cant-find-your-organization-repositories"
- title: Can’t find your private repositories
url: "/cant-find-your-private-repositories"
- title: 'Clone step failed: Command [git checkout $REVISION] exited with code [1]'
url: "/git-clone-step-issue"
- title: Handling commit messages with a quote character
url: "/handling-commit-messages-with-quotes"
- title: Docker image does not exist or no pull access
url: "/the-docker-image-does-not-exist-or-no-pull-access"
- title: 'Build step: No such file or directory'
url: "/build-step-no-such-file-or-directory"
- title: No Dockerfile found
url: "/no-dockerfile-found"
- title: Failed to create container of image
url: "/create-container-failure"
- title: Failed to tag image
url: "/could-not-tag-image"
- title: Error Code 137
url: "/error-code-137"
- title: Too many requests
url: "/dockerhub-rate-limit"
- title: Restoring data from pre-existing image hangs on
url: "/restoring-data-from-pre-existing-image-hangs-on"
- title: Disabling codefresh caching mechanisms
url: "/disabling-codefresh-caching-mechanisms"
- title: Pinning codefresh.yml for multi-git triggers
url: "/multi-git-triggers"
- title: Workflow terminated by the system
url: "/workflow-terminated-by-system"
- title: cf_export limitations
url: "/cf-export-limitations"
- title: Validation port warnings
url: "/validation-port-warnings"
- title: Forbidden Kubernetes resources
url: "/forbidden-cluster-resources"
- title: How to use SSH keys in freestyle steps
url: "using-ssh-keys"
- title: Failed to get accounts clusters during workflow
url: "/failed-to-get-accounts-clusters-during-workflow"
- title: Paging issues for builds and images
url: "/paging-issues-builds-images"
- title: Deprecating personal Git integrations
url: "/personal-git-deprecation"
- title: GitOps runtimes
url: "/runtime-issues"

- title: How Tos
url: "/how-to"
- title: Troubleshooting
url: "/troubleshooting"
- title: Codefresh SLA Definitions
url: "/codefresh-sla-definitions"


- title: Terms and Privacy Policy
Expand Down
2 changes: 1 addition & 1 deletion_docs/installation/gitops/hybrid-gitops.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1305,4 +1305,4 @@ data:
[Monitoring & managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/)
[Add Git Sources to runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
[Shared configuration repo]({{site.baseurl}}/docs/reference/shared-configuration)
[Troubleshoot Hybrid Runtime installation]({{site.baseurl}}/docs/troubleshooting/runtime-issues/)
[Troubleshoot Hybrid Runtime installation]({{site.baseurl}}/docs/kb/articles/runtime-issues/)
2 changes: 1 addition & 1 deletion_docs/installation/gitops/monitor-manage-runtimes.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -640,7 +640,7 @@ status:

A notification _Unable to communicate with a <runtime_name>_ or _Unable to communicate with two or more runtimes_ indicates a communication problem.

Refer to our [troubleshooting section]({{site.baseurl}}/docs/troubleshooting/runtime-issues/#unable-to-communicate-with-runtime-name-or-two-or-more-runtimes) for a list of possible causes and the corresponding corrective actions.
Refer to our [troubleshooting section]({{site.baseurl}}/docs/kb/articles/runtime-issues/#unable-to-communicate-with-runtime-name-or-two-or-more-runtimes) for a list of possible causes and the corresponding corrective actions.


### (Hybrid GitOps) View notifications in Activity Log
Expand Down
2 changes: 1 addition & 1 deletion_docs/integrations/kubernetes.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -583,7 +583,7 @@ kubectl create clusterrolebinding default-admin --clusterrole cluster-admin --se

### Kubernetes cluster - using an external reverse proxy (edge case)

In caseyou'reusing an external reverse proxy to manage inbound traffic to your Kubernetes API,please read[this article]({{site.baseurl}}/docs/troubleshooting/common-issues/verify-cluster-tls-ssl-configuration/) to make sure your certificate setup are managed correctly in order to add your cluster successfully to Codefresh.
Ifyou areusing an external reverse proxy to manage inbound traffic to your Kubernetes API,for correct certificate setup, see[this article]({{site.baseurl}}/docs/kb/articles/verify-cluster-tls-ssl-configuration/).

### Multiple CAs in certificate chain

Expand Down
27 changes: 27 additions & 0 deletions_docs/kb/articles/403-error-codefresh-cli-in-build.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
---
title: 403 Forbidden Error On Codefresh CLI Commands Within Build
description:
group: kb
sub-group: articles
toc: true
kb: true
ht: false
common: false
categories: [CLI, Pipelines]
support-reviewed: 2023-04-18 LG
---

## Overview

When running a Codefresh CLI command from within a build, it fails with a 403 forbidden error.

## Details

Builds are run with the user context of the user who started it. So if any Codefresh CLI commands within a build fails with a 403 error, that means the user who started the build does not have the permissions to run this command.

1. Make sure this user is intended to have permissions to the actions performed by these CLI commands.
2. As an account admin, make modifications to this user's team assignment and/or your account's permissions rules to grant this user access on relevant objects and actions.

## Related Items

[Configuring Access Control]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
69 changes: 69 additions & 0 deletions_docs/kb/articles/about-reusevolumeselector-options.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
---
title: About reuseVolumeSelector options
description:
group: kb
sub-group: articles
toc: true
kb: true
ht: false
common: false
categories: [Runtimes]
support-reviewed: 2023-04-18 LG
---

## Overview

The behavior of how the volumes are reused depends on volume selector configuration.

`reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName'`

That means that a determined volume can be used by any pipeline of your account.

`reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName,pipeline_id'`

That means that a determined PV can be used only by a specific pipeline.

## Details

For approach _codefresh-app,io.codefresh.accountName_ :

* Benefit: less PVs --> lower cost (since any PV can be used by any pipeline, then, the cluster would need to keep less PVs in its pool of PVs for Codefresh)
* Downside: since the PV can be used by any pipeline, then, the PVs could have assets and info from different pipelines, thus reducing the probability of cache,

For approach _codefresh-app,io.codefresh.accountName,pipeline_id_ :

* Benefit: more probability of cache (no "spam" from other pipelines)
* Downside: more PVs to keep (higher cost)

### How-to change the reuseVolumeSelector in your Runtime Environment

To make the changes in your Runtime Environment, you will need to use the
[Codefresh CLI.](https://codefresh-io.github.io/cli/installation/)

1. Get your Runtime Environment:

```shell
codefresh get re <name> -o yaml > spec.yaml
```

1. Modify the reuseVolumeSelector in the the downloaded file, in the example
below we change it to per-pipeline mode:

``` yaml
...
pvcs:
dind:
...
reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName, **pipeline_id** '
...
```

1. Patch your RE using the following CLI command:

```shell
codefresh patch re -f spec.yaml
```

## Related items

[Volume Reusage Policy]({{site.baseurl}}/docs/installation/codefresh-runner/#volume-reuse-policy)
32 changes: 32 additions & 0 deletions_docs/kb/articles/access-is-denied-when-using-a-clone-step.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
---
title: Attempting to clone from a repo but access is denied
description:
group: kb
sub-group: articles
toc: true
kb: true
ht: false
common: false
categories: [Pipelines]
support-reviewed: 2023-04-18 LG
---

## Overview

Access is denied when using a clone step

## Details

Insufficient access in the Git integration, or incorrect Git integration
used.:

* Ensure that the account used in Integrations has the appropriate access.
* Ensure that in your clone step, you are using the right name for the git provider.
* If the account used to set up integration is no longer active, you will need to remove the current integration and replace it.

1. Go to your [Account Settings -> Integrations -> Git](https://g.codefresh.io/account-admin/account-conf/integration/git).
* If you do not have access, please contact one of your team's admins
2. Update the previous integration with a new token, or delete the previous integration
3. Create a new integration

> Note: When deleting a git integration, you may get an error saying the integration cannot be deleted while other objects are using it. This means an existing pipeline is referencing the integration. Please refer to [How-to: Update Trigger Git Context]({{site.baseurl}}/docs/kb/articles/update-trigger-git-context) on how to find and modify these existing references.
27 changes: 27 additions & 0 deletions_docs/kb/articles/account-invite-not-permitting-login.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
---
title: Account invitation not permitting login
description:
group: kb
sub-group: articles
toc: true
kb: true
ht: false
common: false
categories: [Settings, General]
support-reviewed: 2023-04-18 LG
---

## Overview

1. Accepting an invite does not allow you to access the inviting account.
2. Accepting an invite does not work, and fails to let you log in.

## Details

The account is not correctly linked.

1. Ensure that the email account you're logging in with is the same as the email address used for the invite.
2. Log out of any previous sessions with the relevant identity provider and if need be, try a different browser or a private/incognito window.
3. If you are able to log in but don't see the inviting account, your user may be under multiple accounts. If this is the case, you can switch between available accounts via the user menu drop-down in the upper right-hand corner.

_Notes_ In the event that this issue persists, please [contact our supportteam](https://support.codefresh.io/hc/en-us/requests/new) with as many details as you have.
22 changes: 22 additions & 0 deletions_docs/kb/articles/acquire-webhook-information.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
title: "How To: Acquire webhook information after a git trigger has been created"
description:
group: kb
sub-group: articles
toc: true
kb: false
ht: true
common: false
categories: [Pipelines, CLI]
support-reviewed: 2023-04-18 LG
---

## Overview

Currently, there is no way to gather this information via the Codefresh Web Interface. This information can be acquired via the CLI / API call to get the pipeline spec.

## Details

1. `codefresh get pipeline Project/Pipeline -o yaml`
2. Under spec.triggers you can see the information about each git trigger.
3. Information you will need is the **endpoint** and **secret** fields
62 changes: 62 additions & 0 deletions_docs/kb/articles/add-link-to-parrent-from-child-pipeline.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
---
title: "How To: Add a direct link to the Parent build from a Child build"
description:
group: kb
sub-group: articles
toc: true
kb: false
ht: true
common: false
categories: [Pipelines]
support-reviewed: 2023-04-18 LG
---

## Overview

The Parent-Child approach is a common pattern when defining your CI/CD processes. It's possible to implement that model in Codefresh when using the `codefresh-run` plugin ([link](https://codefresh.io/steps/step/codefresh-run)).

Given the popularity of this pattern, it's also common having to navigate from the Parent-build to its Child-build. This functionality is natively provided by the platform.

But, currently, it's not possible to easily navigate from the Child-build to its parent.

In this article we'll provide a solution for that scenario.

## Details

Every build that is executed by a call to a `codefresh-run` plugin is enriched with a special annotation that precisely identifies its parent.

The name of this annotation is `cf_predecessor`. We can query the value of this annotation in the Child-build, and using that information we can know its parent. Specifically, it's possible to get the ID of the Parent-build.

With that information, it's also possible to build a link to the Parent-build by constructing the corresponding build-URL.

### Implementation

Since all the information can be inferred from the Child-build itself, there's nothing to add or modify in the Parent-build.

You'll need to simply add this step to the Child-build. For example, at the beginning of the pipeline:

{% raw %}

```yaml
steps:
...
linkToParentBuild:
image: codefresh/cli
commands:
- export parentBuildId=$(codefresh get annotation build ${{CF_BUILD_ID}} cf_predecessor -o json | jq -r '.value')
- cf_export linkToParentBuild_CF_OUTPUT_URL="${{CF_URL}}/build/${parentBuildId}"
...
```

{% endraw %}

![Link to Parent-build]({{site.baseurl}}/images/troubleshooting//how-to-navigate-to-parent-build-from-child-build.png)

> Note:
>
> For the in-step-link to work, the name of the `cf_export`ed variable must follow this pattern: `<name|key_of_step>_CF_OUTPUT_URL`, and its value should be the URL to link to.

## Related Items

* [Codefresh Run plugin](https://codefresh.io/steps/step/codefresh-run)
* [Annotations in Codefresh]({{site.baseurl}}/docs/pipelines/annotations/)
36 changes: 36 additions & 0 deletions_docs/kb/articles/add-public-ecr-integration.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
---
title: "How To: Add Public ECR registry integration"
description:
group: kb
sub-group: articles
toc: true
kb: false
ht: true
common: false
categories: [Settings]
support-reviewed: 2023-04-18 LG
---

## Overview

You want to add a Public ECR integration in your Codefresh account.

## Details

You can use **Other Registries** option in the Docker integration page to add a Public ECR integration.

You will need to pass username and password to create the integration. You can get these values from the AWS console:

* Navigate to "Amazon ECR/Repositories/Public/<repo>" and click the "View push commands" button at the upper right, in the next window note the first command that will print out the password.

![excerpt from aws]({{site.baseurl}}/images/troubleshooting/ecrrepo.png)

In the Codefresh [integration page](https://g.codefresh.io/account-admin/account-conf/integration/registryNew) select 'Add Registry Provider > Other Registries', enter any Registry name, put "AWS" in the Username field, then run the following command

`aws ecr-public get-login-password --region us-east-1`

and put the output in the Password field, fill in the prefix field in advanced options too.

![ECR integration in Codefresh]({{site.baseurl}}/images/troubleshooting/ecrrepo2.png)

Test the connection if needed and save the changes.
Loading

[8]ページ先頭

©2009-2025 Movatter.jp