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

Commit0ed97a9

Browse files
KB to Docs 2024 July 31 (#1027)
* moved cf_export limitation to docs* fixed codeblock display issue* renamed heading and and update variables* fixed example code snippe formatting* moved Public ECR to docs* moved windows items together* removed duplicate KB* cron timezone already in docs* Fix formatting* Update variables.md---------Co-authored-by: NimRegev <nima.regev@codefresh.io>
1 parent87dbfea commit0ed97a9

13 files changed

+357
-486
lines changed

‎_docs/incubation/windows.md‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,17 @@ If you have projects in your organization based on the .NET Framework or are in
1717
1818
Once approved, you will get access to a new runtime environment on a dedicated Windows Server version 1709 VM. This means that you will be able to run both Windows and Linux/x86 builds from the same Codefresh account by choosing the appropriate[pipeline settings]({{site.baseurl}}/docs/pipelines/pipelines/#pipeline-settings).
1919

20-
2120
>Note: For .NET Core projects you can use a standard Linux based Codefresh account. See[our example]({{site.baseurl}}/docs/example-catalog/ci-examples/dotnet/).
22-
Codefresh Windows pipelines support the following Codefresh steps:
23-
**Clone**,**Build**,**Push**,**Composition**,**Deploy** and**Freestyle**.
24-
Please refer to our[steps documentation]({{site.baseurl}}/docs/pipelines/steps/) to learn more about each of them.
25-
21+
>Codefresh Windows pipelines support the following Codefresh steps:
22+
>**Clone**,**Build**,**Push**,**Composition**,**Deploy** and**Freestyle**.
23+
>Please refer to our[steps documentation]({{site.baseurl}}/docs/pipelines/steps/) to learn more about each of them.
2624
2725
##Example
2826

2927
In this example we'll perform the following steps:
30-
28+
3129
- Clone our git repository and build a .NET Framework image.
32-
3330
- Run our dotnet unit tests and according to the results annotate the image accordingly.
34-
3531
- Push to Dockerhub if our tests have passed.
3632

3733
```yaml
@@ -74,10 +70,27 @@ steps:
7470
tag:'{% raw %}${{CF_BRANCH_TAG_NORMALIZED}}{% endraw %}'
7571
registry:dockerhub
7672

77-
```
73+
```
74+
75+
##Windows docker image compatibility
76+
77+
You can receive the following error in your Windows pipeline:
78+
79+
`The container operating system does not match the host operating system.`
80+
81+
Windows docker images are only compatible with the corresponding release version of the host OS. You are not able to use a newer release version of a Windows container on an older release of Windows.
82+
83+
Please ensure that the image version used corresponds to the the node Windows release. For example:
84+
85+
`FROM mcr.microsoft.com/dotnet/framework/sdk:4.8-windowsservercore-ltsc2019` is version 1809.
86+
87+
`FROM mcr.microsoft.com/dotnet/framework/sdk:4.8-windowsservercore-1909` is version 1909.
88+
89+
Please reach out to the support team if you're unsure which Windows release you're using.
7890

7991
##Related articles
80-
[Introduction to pipelines]({{site.baseurl}}/docs/pipelines/introduction-to-codefresh-pipelines/)
92+
93+
[Introduction to pipelines]({{site.baseurl}}/docs/pipelines/introduction-to-codefresh-pipelines/)
8194
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)
82-
[Codefresh YAML]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
95+
[Codefresh YAML]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
8396
[Installation options]({{site.baseurl}}/docs/installation/installation-options/)

‎_docs/integrations/docker-registries/amazon-ec2-container-registry.md‎

Lines changed: 93 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,22 @@ toc: true
1111

1212
##Set up ECR integration for IAM user
1313

14-
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select[**Pipeline Integrations**](https://g.codefresh.io/account-admin/account-conf/integration){:target="\_blank"}.
14+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select[**Pipeline Integrations**](https://g.codefresh.io/account-admin/account-conf/integration){:target="\_blank"}.
1515
1. Select**Docker Registries** and then click**Configure**.
1616
1. From the**Add Registry Provider** dropdown, select**Amazon ECR**.
17-
1. Define the following:
18-
***Registry name**: A unique name for this configuration.
19-
***Region**: AWS region.
20-
***Access Key ID**: Your AWS accessKeyId.
21-
***Secret Access Key**: Your AWS accessKeyId.
22-
23-
{% include image.html
24-
lightbox="true"
25-
file="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
26-
url="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
27-
alt="Amazon EC2 Container Registry settings"
28-
caption="Amazon EC2 Container Registry settings"
29-
max-width="60%" %}
30-
17+
1. Define the following:
18+
***Registry name**: A unique name for this configuration.
19+
***Region**: AWS region.
20+
***Access Key ID**: Your AWS accessKeyId.
21+
***Secret Access Key**: Your AWS accessKeyId.
22+
23+
{% include image.html
24+
lightbox="true"
25+
file="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
26+
url="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
27+
alt="Amazon EC2 Container Registry settings"
28+
caption="Amazon EC2 Container Registry settings"
29+
max-width="60%" %}
3130
{:start="5"}
3231
1. To verify the connection details, click**Test Connection**.
3332
1. To apply the changes, click**Save**.
@@ -36,24 +35,24 @@ Codefresh makes sure to automatically refresh the AWS token for you.
3635

3736
For more information on how to obtain the needed tokens, read the[AWS documentation](http://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys){:target="_blank"}.
3837

39-
>**NOTE**
40-
You must have an active registry set up in AWS.<br /><br />
41-
Amazon ECR push/pull operations are supported with two permission options: user-based and resource-based.
42-
38+
>**NOTE**
39+
>You must have an active registry set up in AWS.
40+
>
41+
>Amazon ECR push/pull operations are supported with two permission options: user-based and resource-based.
4342
44-
* Identity-based policies
43+
* Identity-based policies
4544
User account must apply`AmazonEC2ContainerRegistryPowerUser` policy (or custom based on that policy).
4645
For more information and examples, click[here](http://docs.aws.amazon.com/AmazonECR/latest/userguide/ecr_managed_policies.html){:target="_blank"}.
47-
* Resource-based policy
46+
* Resource-based policy
4847
Users with resource-based policies must be allowed to call`ecr:GetAuthorizationToken` before they can authenticate to a registry, and push or pull any images from any Amazon ECR repository, than you need provide push/pull permissions to specific registry.
4948
For more information and examples, click[here](http://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicies.html){:target="_blank"}.
5049

51-
5250
##Set up ECR integration for service account
5351

54-
Setting up ECR integration for a service account applies to accounts with the Codefresh Runner installation.
52+
Setting up ECR integration for a service account applies to accounts with the Codefresh Runner installation.
5553

5654
###Kubernetes service account setup
55+
5756
To use an IAM role, you must set up a Kubernetes service account, as described in the[AWS Documentation](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html){:target="\_blank"}.
5857
You can define the service account at four different levels, based on the required priority. The levels are listed below in ascending order of priority:
5958

@@ -80,37 +79,70 @@ runtimeScheduler:
8079
* Trigger
8180
The Trigger-level service account has the highest priority. Define the service account as part of the trigger settings for the specific pipeline (Workflow > Triggers (modify or add) > Advanced Options).
8281

83-
8482
###How to
8583

86-
#####Before you begin
84+
####Before you begin
85+
8786
* Define a Kubernetes service account for the runtime, account, pipeline, or pipeline-trigger
8887

89-
#####How to
88+
####Steps
9089

91-
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select[**Pipeline Integrations**](https://g.codefresh.io/account-admin/account-conf/integration){:target="\_blank"}.
90+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select[**Pipeline Integrations**](https://g.codefresh.io/account-admin/account-conf/integration){:target="\_blank"}.
9291
1. Select**Docker Registries** and then click**Configure**.
9392
1. From the**Add Registry Provider** dropdown, select**Amazon ECR**.
9493
1. Do the following:
95-
***Registry name**: Enter a unique name for this configuration.
96-
***Region**: Select the AWS region.
97-
* Select**Resolve credentials from servce account**.
98-
99-
The Access Key ID and Secret Access Key fields are disabled.
100-
101-
{% include image.html
102-
lightbox="true"
103-
file="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
104-
url="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
105-
alt="Amazon EC2 Container Registry settings"
106-
caption="Amazon EC2 Container Registry settings"
107-
max-width="60%" %}
108-
94+
***Registry name**: Enter a unique name for this configuration.
95+
***Region**: Select the AWS region.
96+
* Select**Resolve credentials from servce account**.
97+
* The Access Key ID and Secret Access Key fields are disabled.
98+
99+
{% include image.html
100+
lightbox="true"
101+
file="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
102+
url="/images/integrations/docker-registries/add-amazon-ecr-registry.png"
103+
alt="Amazon EC2 Container Registry settings"
104+
caption="Amazon EC2 Container Registry settings"
105+
max-width="60%" %}
109106
{:start="5"}
110107
1. To verify the connection details, click**Test Connection**.
111108
1. To apply the changes, click**Save**.
112109

113-
110+
##Public ECR registry integration
111+
112+
You can use**Other Registries** option in the Docker integration page to add a Public ECR integration.
113+
114+
1. You will need to pass username and password to create the integration. You can get these values from the AWS console:
115+
1. Navigate to "Amazon ECR/Repositories/Public/$REPO".
116+
1. Click the "View push commands" button at the upper right.
117+
1. In the next window note the first command that will print out the password.
118+
{% include image.html
119+
lightbox="true"
120+
file="/images/integrations/docker-registries/public-ecr-repo.png"
121+
url="/images/integrations/docker-registries/public-ecr-repo.png"
122+
alt="Public Amazon EC2 Container Registry Command"
123+
caption=""
124+
max-width="60%" %}
125+
{:start="2"}
126+
1. In the Codefresh[integration page](https://g.codefresh.io/account-admin/account-conf/integration/registryNew) select 'Add Registry Provider > Other Registries'
127+
1. Enter any Registry name
128+
1. Put "AWS" in the Username field
129+
1. Run the following command from the AWS Console:
130+
131+
```shell
132+
aws ecr-public get-login-password --region us-east-1
133+
```
134+
135+
1. Put the outputin the Password field
136+
1. Fillin the prefix fieldin advanced options too.
137+
{% include image.html
138+
lightbox="true"
139+
file="/images/integrations/docker-registries/public-ecr-repo2.png"
140+
url="/images/integrations/docker-registries/public-ecr-repo2.png"
141+
alt="Codefresh Other Docker Registry Form"
142+
caption=""
143+
max-width="60%" %}
144+
{:start="3"}
145+
1. Test the connectionif needed and save the changes.
114146

115147
## Pushing Docker images to Amazon ECR
116148

@@ -121,62 +153,61 @@ There are two ways to push images:
121153

122154
For more details on how to push a Docker imagein a pipeline see the [build and push example]({{site.baseurl}}/docs/example-catalog/ci-examples/build-and-push-an-image/).
123155

124-
125-
126156
### Manually promoting an image
127157

128158
<!-- may need to rewrite this -->
129159

130160
The**Images** view has an option to manually push images to a registry.
131161
You need to specify the repository name as the name of your repository assetin ECR, asin the example below.
132162

133-
{% include image.html
134-
lightbox="true"
135-
file="/images/integrations/docker-registries/ecr/ecr-manual-promote-repo-name.png"
163+
{% include image.html
164+
lightbox="true"
165+
file="/images/integrations/docker-registries/ecr/ecr-manual-promote-repo-name.png"
136166
url="/images/integrations/docker-registries/ecr/ecr-manual-promote-repo-name.png"
137167
alt="Repository name in ECR"
138168
caption ="Repository name in ECR"
139169
max-width="40%"
140170
%}
141171

142-
1. In the Codefresh UI, from Artifacts in the sidebar, select[**Images**](https://g.codefresh.io/2.0/images){:target="\_blank"}.
172+
1. In the Codefresh UI, from Artifactsin the sidebar,select[**Images**](https://g.codefresh.io/2.0/images){:target="\_blank"}.
143173
1. Click**Promote**.
144174

145-
{% include image.html
146-
lightbox="true"
147-
file="/images/integrations/docker-registries/ecr/ecr-manual-promote-button.png"
175+
{% include image.html
176+
lightbox="true"
177+
file="/images/integrations/docker-registries/ecr/ecr-manual-promote-button.png"
148178
url="/images/integrations/docker-registries/ecr/ecr-manual-promote-button.png"
149179
alt="Promote image icon"
150180
caption="Promote image icon"
151181
max-width="40%"
152182
%}
153183

154184
{:start="3"}
185+
155186
1. Do the following:
156-
* Enter the**Repository Name**.
157-
* Enter the**Tag**. Copy and paste the text after the`:` in the Repository Name. For example,`repository-name:tag`.
158-
* From the**Registry** dropdown, select your ECR configuration.
159187

160-
{% include image.html
161-
lightbox="true"
162-
file="/images/integrations/docker-registries/ecr/ecr-manual-promote-settings.png"
188+
* Enter the**Repository Name**.
189+
* Enter the**Tag**. Copy and paste the text after the`:`in the Repository Name. For example,`repository-name:tag`.
190+
* From the**Registry** dropdown,selectyour ECR configuration.
191+
192+
{% include image.html
193+
lightbox="true"
194+
file="/images/integrations/docker-registries/ecr/ecr-manual-promote-settings.png"
163195
url="/images/integrations/docker-registries/ecr/ecr-manual-promote-settings.png"
164196
alt="Image promotion settings"
165197
caption="Image promotion settings"
166198
max-width="40%"
167-
%}
199+
%}
168200

169201
{:start="4"}
170-
1. Click**Promote**.
171202

203+
1. Click**Promote**.
172204

173-
>**NOTE**
205+
>**NOTE**
174206
You can change the image nameif you want, but make sure that the new name exists as a repositoryin ECR.
175207

176-
177208
## Related articles
209+
178210
[Docker registriesfor pipeline integrations]({{site.baseurl}}/docs/integrations/docker-registries/)
179211
[Working with Docker Registries]({{site.baseurl}}/docs/ci-cd-guides/working-with-docker-registries/)
180212
[Push step]({{site.baseurl}}/docs/pipelines/steps/push/)
181213
[Building and pushing an image]({{site.baseurl}}/docs/example-catalog/ci-examples/build-and-push-an-image/)
182-

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

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎_docs/kb/articles/automating-shared-secrets-creation.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ support-reviewed: 2024-01-17 MB
1313

1414
This articles describes how to manage secrets across different pipelines in an efficient manner.
1515

16-
1716
##Script for create secret context
1817

1918
The script reads each line from the provided file and appends it to the Codefresh`create context secret` command.
@@ -24,7 +23,7 @@ Ensure you have the necessary permissions to create contexts in Codefresh.
2423

2524
#####Script
2625

27-
```bash
26+
```shell
2827
#!/bin/bash
2928

3029
CMD="codefresh create context secret <secret_context_name>"
@@ -38,10 +37,10 @@ done < "$1"
3837
echo"$CMD"
3938
```
4039

41-
##How to use the script
40+
##How to use the script
4241

43-
1. Prepare the list of your secrets.
44-
Start by preparing a file containing your secrets.
42+
1. Prepare the list of your secrets.
43+
Start by preparing a file containing your secrets.
4544
Each line in the file should contain one secret in the format KEY=VALUE.
4645

4746
2. Set execution permissions.
@@ -56,9 +55,8 @@ echo "$CMD"
5655
4. Verify creation.
5756
After executing the script, verify that the secret context has been created in Codefresh with the specified secrets.
5857

59-
60-
6158
##Related articles
59+
6260
[Secrets in pipelines]({{site.baseurl}}/docs/pipelines/configuration/secrets-store/)
63-
[Configuring access control for pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
64-
[Pipeline execution context]({{site.baseurl}}/docs/administration/account-user-management/pipeline-execution-context/)
61+
[Configuring access control for pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
62+
[Pipeline execution context]({{site.baseurl}}/docs/administration/account-user-management/pipeline-execution-context/)

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp