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

Commit62f9738

Browse files
committed
formatting and verify links
1 parent8fb9bb2 commit62f9738

File tree

65 files changed

+880
-1064
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+880
-1064
lines changed

‎_docs/troubleshooting/kb-articles/403-error-codefresh-cli-in-build.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,15 @@ support-reviewed: 2023-04-18 LG
1212

1313
##Overview
1414

15-
When running a Codefresh CLI command from within a build, it fails with a 403
16-
forbidden error.
15+
When running a Codefresh CLI command from within a build, it fails with a 403 forbidden error.
1716

1817
##Details
1918

20-
Builds are run with the user context of the user who started it. So if any
21-
Codefresh CLI commands within a build fails with a 403 error, that means the
22-
user who started the build does not have the permissions to run this command.
19+
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.
2320

24-
1. Make sure this user is intended to have permissions to the actions performed by these CLI commands.
25-
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.
21+
1. Make sure this user is intended to have permissions to the actions performed by these CLI commands.
22+
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.
2623

2724
##Related Items
2825

29-
[Configuring Access Control]({% link_docs/administration/account-user-management/access-control.md %})
26+
[Configuring Access Control]({{site.baseurl}}/docs/administration/account-user-management/access-control/)

‎_docs/troubleshooting/kb-articles/about-reusevolumeselector-options.md‎

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,11 @@ support-reviewed: 2023-04-18 LG
1212

1313
##Overview
1414

15-
The behavior of how the volumes are reused depends on volume selector
16-
configuration.
15+
The behavior of how the volumes are reused depends on volume selector configuration.
1716

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

20-
That means that a determined volume can be used by any pipeline of your
21-
account.
19+
That means that a determined volume can be used by any pipeline of your account.
2220

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

@@ -28,42 +26,43 @@ That means that a determined PV can be used only by a specific pipeline.
2826

2927
For approach_codefresh-app,io.codefresh.accountName_ :
3028

31-
* 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)
32-
* 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,
29+
* 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)
30+
* 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,
3331

3432
For approach_codefresh-app,io.codefresh.accountName,pipeline_id_ :
3533

36-
* Benefit: more probability of cache (no "spam" from other pipelines)
37-
* Downside: more PVs to keep (higher cost)
34+
* Benefit: more probability of cache (no "spam" from other pipelines)
35+
* Downside: more PVs to keep (higher cost)
3836

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

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

44-
1\. Get your Runtime Environment:
42+
1. Get your Runtime Environment:
4543

46-
`codefresh get re <name> -o yaml > spec.yaml`
44+
```shell
45+
codefresh get re<name> -o yaml> spec.yaml
46+
```
4747

48-
2\. Modify the reuseVolumeSelector in the the downloaded file, in the example
48+
1. Modify the reuseVolumeSelectorin the the downloaded file,in the example
4949
below we change it to per-pipeline mode:
5050

51-
52-
51+
``` yaml
5352
...
5453
pvcs:
5554
dind:
56-
...
57-
reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName, **pipeline_id** '
58-
...
55+
...
56+
reuseVolumeSelector:'codefresh-app,io.codefresh.accountName, **pipeline_id**'
57+
...
58+
```
5959

60-
3\. Patch your RE using the following CLI command:
61-
62-
`codefresh patch re -f spec.yaml`
60+
1. Patch your RE using the following CLI command:
6361

64-
##Related items
62+
```shell
63+
codefresh patch re -f spec.yaml
64+
```
6565

66-
[Volume Reusage
67-
Policy](https://codefresh.io/docs/docs/administration/codefresh-
68-
runner/#volume-reusage-policy)
66+
## Related items
6967

68+
[Volume Reusage Policy]({{site.baseurl}}/docs/installation/codefresh-runner/#volume-reuse-policy)

‎_docs/troubleshooting/kb-articles/access-is-denied-when-using-a-clone-step.md‎

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,13 @@ Access is denied when using a clone step
1919
Insufficient access in the Git integration, or incorrect Git integration
2020
used.:
2121

22-
* Ensure that the account used in Integrations has the appropriate access.
23-
* Ensure that in your clone step, you are using the right name for the git provider.
24-
* If the account used to set up integration is no longer active, you will need to remove the current integration and replace it.
25-
1. Go to your[Account Settings -> Integrations -> Git](https://g.codefresh.io/account-admin/account-conf/integration/git).
22+
* Ensure that the account used in Integrations has the appropriate access.
23+
* Ensure that in your clone step, you are using the right name for the git provider.
24+
* If the account used to set up integration is no longer active, you will need to remove the current integration and replace it.
2625

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

31-
_Notes_
32-
33-
When deleting a git integration, you may get an error saying the integration
34-
cannot be deleted while other objects are using it. This means an existing
35-
pipeline is referencing the integration. Please refer to[How-to: Update
36-
Trigger Git Context](https://support.codefresh.io/hc/en-
37-
us/articles/360020967860) on how to find and modify these existing references.
31+
>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/troubleshooting/kb-articles/update-trigger-git-context) on how to find and modify these existing references.

‎_docs/troubleshooting/kb-articles/account-invite-not-permitting-login.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,15 @@ support-reviewed: 2023-04-18 LG
1212

1313
##Overview
1414

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

1818
##Details
1919

2020
The account is not correctly linked.
2121

22-
1. Ensure that the email account you're logging in with is the same as the email address used for the invite.
23-
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.
24-
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.
22+
1. Ensure that the email account you're logging in with is the same as the email address used for the invite.
23+
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.
24+
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.
2525

26-
_Notes_ In the event that this issue persists, please[contact our support
27-
team](https://support.codefresh.io/hc/en-us/requests/new) with as many details
28-
as you have.
26+
_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.

‎_docs/troubleshooting/kb-articles/acquire-webhook-information.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@ support-reviewed: 2023-04-18 LG
1212

1313
##Overview
1414

15-
Currently, there is no way to gather this information via the Codefresh Web
16-
Interface. This information can be acquired via the CLI / API call to get the
17-
pipeline spec.
15+
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.
1816

1917
##Details
2018

21-
1.`codefresh get pipeline Project/Pipeline -o yaml`
22-
2. Under spec.triggers you can see the information about each git trigger.
23-
3. Information you will need is the**endpoint** and**secret** fields
24-
19+
1.`codefresh get pipeline Project/Pipeline -o yaml`
20+
2. Under spec.triggers you can see the information about each git trigger.
21+
3. Information you will need is the**endpoint** and**secret** fields

‎_docs/troubleshooting/kb-articles/add-link-to-parrent-from-child-pipeline.md‎

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,42 +12,31 @@ support-reviewed: 2023-04-18 LG
1212

1313
##Overview
1414

15-
The Parent-Child approach is a common pattern when defining your CI/CD
16-
processes. It's possible to implement that model in Codefresh when using the
17-
`codefresh-run` plugin ([link](https://codefresh.io/steps/step/codefresh-
18-
run)).
15+
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)).
1916

20-
Given the popularity of this pattern, it's also common having to navigate from
21-
the Parent-build to its Child-build. This functionality is natively provided
22-
by the platform.
17+
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.
2318

24-
But, currently, it's not possible to easily navigate from the Child-build to
25-
its parent.
19+
But, currently, it's not possible to easily navigate from the Child-build to its parent.
2620

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

2923
##Details
3024

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

34-
The name of this annotation is`cf_predecessor`. We can query the value of
35-
this annotation in the Child-build, and using that information we can know its
36-
parent. Specifically, it's possible to get the ID of the Parent-build.
27+
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.
3728

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

4131
###Implementation
4232

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

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

49-
50-
37+
{% raw %}
38+
39+
```yaml
5140
steps:
5241
...
5342
linkToParentBuild:
@@ -56,20 +45,17 @@ beginning of the pipeline:
5645
-export parentBuildId=$(codefresh get annotation build ${{CF_BUILD_ID}} cf_predecessor -o json | jq -r '.value')
5746
-cf_export linkToParentBuild_CF_OUTPUT_URL="${{CF_URL}}/build/${parentBuildId}"
5847
...
59-
48+
```
49+
50+
{% endraw %}
6051

61-
![Link to Parent-
62-
build](https://support.codefresh.io/hc/article_attachments/360024616939/how-
63-
to-navigate-to-parent-build-from-child-build.png)
52+
![Link to Parent-build](/images/troubleshooting//how-to-navigate-to-parent-build-from-child-build.png)
6453

6554
>Note:
6655
>
67-
>For the in-step-link to work, the name of the`cf_export`ed variable must
68-
>follow this pattern:`<name|key_of_step>_CF_OUTPUT_URL`, and its value
69-
>should be the URL to link to.
56+
>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.
7057
7158
##Related Items
7259

73-
*[Codefresh Run plugin](https://codefresh.io/steps/step/codefresh-run)
74-
*[Annotations in Codefresh](https://codefresh.io/docs/docs/codefresh-yaml/annotations/)
75-
60+
*[Codefresh Run plugin](https://codefresh.io/steps/step/codefresh-run)
61+
*[Annotations in Codefresh]({{site.baseurl}}/docs/pipelines/annotations/)

‎_docs/troubleshooting/kb-articles/add-public-ecr-integration.md‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,20 @@ You want to add a Public ECR integration in your Codefresh account.
1616

1717
##Details
1818

19-
You can use**Other Registries** option in the Docker integration page to add
20-
a Public ECR integration.
19+
You can use**Other Registries** option in the Docker integration page to add a Public ECR integration.
2120

22-
You will need to pass username and password to create the integration. You can
23-
get these values from the AWS console:
21+
You will need to pass username and password to create the integration. You can get these values from the AWS console:
2422

25-
* 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.
23+
* 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.
2624

27-
![](/attachments/token/ZgWLZOUmiEUk0ZwienyjQOmAd/?name=Selection_656.png)
25+
![excerpt from aws](/images/troubleshooting/ecrrepo.png)
2826

29-
In the Codefresh[integration page](https://g.codefresh.io/account-
30-
admin/account-conf/integration/registryNew) select 'Add Registry Provider >
31-
Other Registries', enter any Registry name, put "AWS" in the Username field,
32-
then run the following command
27+
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
3328

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

36-
and put the output in the Password field, fill in the prefix field in advanced
37-
options too.
31+
and put the output in the Password field, fill in the prefix field in advanced options too.
3832

39-
![](/attachments/token/ffh8A8TMJeEqyo17x5kHD2ZY6/?name=Selection_657.png)
33+
![ECR integration in Codefresh](/images/troubleshooting/ecrrepo2.png)
4034

4135
Test the connection if needed and save the changes.
42-

‎_docs/troubleshooting/kb-articles/adding-eks-cluster-programmatically.md‎

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,41 @@ support-reviewed: 2023-04-18 LG
1212

1313
##Overview
1414

15-
As part of your pipeline, you create a new cluster and want to add it to
16-
Codefresh
15+
As part of your pipeline, you create a new cluster and want to add it to Codefresh
1716

1817
##Details
1918

20-
1. Note the name of the cluster in a variable, such as`$K8S_NAME`.
21-
2. After the cluster is created, run the following API call, replacing all with your values or variables:
22-
23-
24-
25-
add_new_cluster:
26-
image: <your-image>
27-
commands:
28-
- curl -s --fail\
29-
-H "Authorization: <CF_API_KEY>"\
30-
-H "content-type: application/json;charset=UTF-8"\
31-
-d\
32-
"{
33-
\"type\":\"sat\",
34-
\"selector\":\"<K8S_NAME>\",
35-
\"host\":\"<K8S_HOST>\",
36-
\"clientCa\":\"<K8S_CA>\",
37-
\"serviceAccountToken\":\<$K8S_TOKEN\>,
38-
\"provider\":\"local\",
39-
\"providerAgent\":\"eks\"
40-
}"\
41-
"$CF_API_HOST/api/clusters/local/cluster"
42-
43-
44-
_**Note** :_ A more detailed[EKS workflow can be found
45-
here](https://github.com/codefresh-io/eks-installer).
19+
1. Note the name of the cluster in a variable, such as`$K8S_NAME`.
20+
2. After the cluster is created, run the following API call, replacing all with your values or variables:
4621

47-
##Related Items
22+
{% raw %}
23+
24+
```yaml
25+
26+
add_new_cluster:
27+
image:<your-image>
28+
commands:
29+
-curl -s --fail \
30+
-H "Authorization:<CF_API_KEY>" \
31+
-H "content-type:application/json;charset=UTF-8" \
32+
-d \
33+
"{
34+
\"type\":\"sat\",
35+
\"selector\":\"<K8S_NAME>\",
36+
\"host\":\"<K8S_HOST>\",
37+
\"clientCa\":\"<K8S_CA>\",
38+
\"serviceAccountToken\":\<$K8S_TOKEN\>,
39+
\"provider\":\"local\",
40+
\"providerAgent\":\"eks\"
41+
}"\
42+
"$CF_API_HOST/api/clusters/local/cluster"
43+
```
4844

49-
[EKS Installer](https://github.com/codefresh-io/eks-installer)[API
50-
documentation - clusters](https://g.codefresh.io/api/#tag/Clusters)
45+
{% endraw %}
46+
47+
>_**Note**:_ A more detailed[EKS workflow can be foundhere](https://github.com/codefresh-io/eks-installer).
48+
49+
##Related Items
5150

51+
*[EKS Installer](https://github.com/codefresh-io/eks-installer)
52+
*[API documentation - clusters](https://g.codefresh.io/api/#tag/Clusters)

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp