- Notifications
You must be signed in to change notification settings - Fork165
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
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
27 commits Select commitHold shift + click to select a range
aff9b78 intial article migration
ThatAmatoGuy78606c0 Merge branch 'master' into support-kb-migration
ThatAmatoGuycffc87a Auto Update Article List
ThatAmatoGuy06785a0 Merge branch 'master' into support-kb-migration
ThatAmatoGuyde8225b added template font matter
ThatAmatoGuy1f1f3ba Updated Font Matter to Docs
ThatAmatoGuy8fb9bb2 update home content to show troubleshooting
ThatAmatoGuy62f9738 formatting and verify links
ThatAmatoGuyc612b2b Updating formating and links
ThatAmatoGuy7e5294c Merge branch 'master' into support-kb-migration
ThatAmatoGuydb0a3a3 updating formating, links, and images
ThatAmatoGuyd911b38 finished updating link, formating, and images
ThatAmatoGuya0b7f9d update paths to check
ThatAmatoGuy1589daa updating page auto-generated links
ThatAmatoGuydefd11c updated URLs to point to the correct kb articles
ThatAmatoGuy7b10c2b testing fix for images
ThatAmatoGuyaa97cd0 updating image URLs
ThatAmatoGuyf0bb685 update with Sasha feedback
ThatAmatoGuy7eeb5ab Update build-step-no-such-file-or-directory.md
a-mankinenkoeb94ec3 updated articles per review
ThatAmatoGuyf5630a0 Merge branch 'master' into support-kb-migration
ThatAmatoGuyb2988ea update variables url for kb
ThatAmatoGuyc950c8a reorg items to include how to
ThatAmatoGuy6736230 updated URLs to new location
ThatAmatoGuy54e9dfb updated metadata and reorg docs
ThatAmatoGuy3119939 updated validation checks
ThatAmatoGuy3ad9e12 Update nav.yml
NimRegevFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions_docs/kb/articles/403-error-codefresh-cli-in-build.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff 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 %} | ||
|  | ||
| > 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff 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. | ||
|  | ||
| 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. | ||
|  | ||
| Test the connection if needed and save the changes. |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.