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

Commit1946a9b

Browse files
Connect to Azure Helm repository with a service account
1 parent0d3f2d4 commit1946a9b

File tree

10 files changed

+169
-76
lines changed

10 files changed

+169
-76
lines changed

‎_data/home-content.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,8 @@
182182
localurl:/docs/deploy-to-kubernetes/codefresh-kubernetes-integration-demochat-example/
183183
-title:Deploy with Helm
184184
localurl:/docs/yaml-examples/examples/helm/
185+
-title:Deploy with Kustomize
186+
localurl:/docs/yaml-examples/examples/deploy-with-kustomize/
185187
-title:Deploy to a VM with Packer
186188
localurl:/docs/yaml-examples/examples/packer-gcloud/
187189
-title:Deploy with Terraform
@@ -216,6 +218,8 @@
216218
-title:Secret Storage
217219
new:true
218220
localurl:/docs/integrations/secret-storage/
221+
-title:Helm
222+
localurl:/docs/integrations/helm/
219223
-title:Argo CD
220224
new:true
221225
localurl:/docs/integrations/argo-cd/

‎_data/nav.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,8 @@
412412
url:"/other-registries"
413413
-title:Secret Storage
414414
url:"/secret-storage"
415+
-title:Helm Integration
416+
url:"/helm"
415417
-title:ArgoCD Integration
416418
url:"/argo-cd"
417419
-title:Jenkins Integration

‎_docs/integrations/helm.md‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
---
2+
title:"Helm Integration"
3+
description:"Manage Helm releases and repositories with Codefresh"
4+
group:integrations
5+
toc:true
6+
---
7+
8+
Codefresh is one of the few devops platforms that has native support for Helm releases and deployments. This includes
9+
10+
* A[built-in Helm repository]({{site.baseurl}}/docs/new-helm/managed-helm-repository/) for all Codefresh accounts
11+
* The ability to add any external Helm repository in addition to the built-in one (this page)
12+
* A pipeline[step for deploying Helm applications]({{site.baseurl}}/docs/new-helm/using-helm-in-codefresh-pipeline/)
13+
* A dashboard for looking at your[Helm charts]({{site.baseurl}}/docs/new-helm/add-helm-repository/)
14+
* A dashboard for looking at your[Helm releases]({{site.baseurl}}/docs/new-helm/helm-releases-management/)
15+
* A dashboard for[promoting Helm releases]({{site.baseurl}}/docs/new-helm/helm-environment-promotion/) between different environments
16+
* A dashboard for[Helm environments]({{site.baseurl}}/docs/deploy-to-kubernetes/environment-dashboard/)
17+
18+
Note that the built-in Helm repository is production ready. You can start using Helm right away with your Codefresh account
19+
even if you don't have an external Helm repository. See our[quick start guide for Helm]({{site.baseurl}}/docs/getting-started/helm-quick-start-guide/) or the[full Helm example]({{site.baseurl}}/docs/yaml-examples/examples/helm/).
20+
21+
##General Helm configuration
22+
23+
To configure your external Helm repositories go to your Account Configuration, by clicking on*Account Settings* on the left sidebar. On the first section called*Integrations* click the*Configure* button next to*Helm*.
24+
25+
{% include image.html
26+
lightbox="true"
27+
file="/images/integrations/codefresh-integrations.png"
28+
url="/images/integrations/codefresh-integrations.png"
29+
alt="Codefresh Account Integration"
30+
max-width="80%" %}
31+
32+
Add a new Helm repository configuration from the drop down.
33+
34+
{% include image.html
35+
lightbox="true"
36+
file="/images/integrations/helm/add-helm-repository.png"
37+
url="/images/integrations/helm/add-helm-repository.png"
38+
alt="Add Helm Repository"
39+
max-width="40%"
40+
%}
41+
42+
Each configuration must be given a unique name, which you can later reference in a codefresh.yml file.
43+
44+
###Private Helm repository - HTTP
45+
46+
You can connect to your repository using HTTP Basic authentication:
47+
48+
- Add your repo URL as usually with HTTP protocol.
49+
- Supply the User and Password for HTTP Basic authentication.
50+
51+
Variables:
52+
53+
Name|Description
54+
---|---
55+
REPOSITORY NAME|Give a unique name to this integration
56+
REPOSITORY URL|Location of the Helm repository
57+
HELMREPO_USERNAME|The username to authenticate with
58+
HELMREPO_PASSWORD|The password for the username provided
59+
60+
###Private Helm repository - S3
61+
62+
- Add your S3 bucket URL in the following scheme:`s3://bucketname`.
63+
- Supply the AWS authentication variables as you would for the AWS CLI, or the S3 plugin for Helm. See details here:[Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html).
64+
65+
Variables:
66+
67+
Name|Description
68+
---|---
69+
REPOSITORY NAME|Give a unique name to this integration
70+
REPOSITORY URL|Location of the Helm repository with format`s3://bucketname`
71+
AWS_ACCESS_KEY_ID|ID of the key with permissions for the bucket
72+
AWS_SECRET_ACCESS_KEY|Secret of the key with permissions for the bucket
73+
AWS_DEFAULT_REGION|region where the bucket was created
74+
75+
###Private Helm repository - GCS
76+
77+
- Add your GCS bucket URL in the following scheme:`gs://bucketname`.
78+
- Supply the Google authentication variable as you would for the GCloud CLI, or the GCS plugin for Helm. See details here:[Creating Service Account](https://cloud.google.com/docs/authentication/getting-started).
79+
80+
Variables:
81+
82+
Name|Description
83+
---|---
84+
REPOSITORY NAME|Give a unique name to this integration
85+
REPOSITORY URL|Location of the Helm repository with format`gs://bucketname`.
86+
GOOGLE_APPLICATION_CREDENTIALS_JSON|The JSON content of the service account credentials
87+
88+
###Private Helm repository - Azure
89+
90+
First make sure that you[create the Helm repository](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-helm-repos) in Azure.
91+
92+
Then click*Authenticate*. You will get a permissions dialog for allowing Codefresh to access
93+
the Azure services. Click*Accept*.
94+
95+
>Make sure that you are using an organizational/company Azure account and not a personal one. We are currently working with Microsoft to improve this integration.
96+
97+
{% include image.html
98+
lightbox="true"
99+
file="/images/integrations/helm/select-azure-helm-repository.png"
100+
url="/images/integrations/helm/select-azure-helm-repository.png"
101+
alt="Selecting an Azure Helm repository"
102+
caption="Selecting an Azure Helm repository"
103+
max-width="70%"
104+
%}
105+
106+
Select your Azure subscription on the left drop-down menu and your Helm repository on the right drop-down menu.
107+
108+
>If you are already authenticated to Azure, and cannot find your Helm repository in the list, try revoking access and authenticating again.
109+
110+
The Azure Helm integration is now ready.
111+
112+
###Private Helm repository - Azure with service principal
113+
114+
An alternative method of adding an Azure Helm repository is by using a service principal. First follow the[instructions for creating a service principal in the Azure portal](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal).
115+
116+
Then from the drop-down menu select*Azure Registry SP*. Click the*Authenticate button* and enter the following details:
117+
118+
*`Client ID`
119+
*`Tenant`
120+
*`Client secret`
121+
122+
{% include image.html
123+
lightbox="true"
124+
file="/images/integrations/helm/add-azure-helm-spn.png"
125+
url="/images/integrations/helm/add-azure-helm-spn.png"
126+
alt="Azure Service principal details"
127+
caption="Azure Service principal details"
128+
max-width="60%"
129+
%}
130+
131+
Click the*Save* button once finished. Assuming that the authentication is successful you will see your available Azure registries that can be used as a Helm repository.
132+
133+
###Private Helm repository from another Codefresh account
134+
135+
You also add the private Helm repository of another Codefresh user as your integration:
136+
137+
138+
Name|Description
139+
---|---
140+
REPOSITORY NAME|Give a unique name to this integration
141+
REPOSITORY URL|Location of the Helm repository with format`cm://repository-name`.
142+
CF API KEY|A token in[order to access the other Codefresh account]({{site.baseurl}}/docs/integrations/codefresh-api/#authentication-instructions).
143+
144+
Note that we**don't** recommend using this practice (sharing the Codefresh Helm repository between accounts). The built-in Helm repository of each account is best used as a private Helm repository of that account. See
145+
more details on[how to make your private Helm public]({{site.baseurl}}/docs/new-helm/managed-helm-repository/#repo-access-level).
146+
147+
148+
149+
##What to Read Next
150+
151+
*[Your private Helm repository]({{site.baseurl}}/docs/new-helm/managed-helm-repository/)
152+
*[How to use Helm in a Codefresh pipeline]({{site.baseurl}}/docs/new-helm/using-helm-in-codefresh-pipeline/)
153+
*[Managing Helm releases]({{site.baseurl}}/docs/new-helm/helm-releases-management/)
154+
*[Helm best practices]({{site.baseurl}}/docs/new-helm/helm-best-practices/)

‎_docs/new-helm/helm-charts-and-repositories.md‎

Lines changed: 8 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ toc: true
1111
The "Helm Charts" page allows you to integrate with external Helm repositories and Helm charts. Note that all Codefresh accounts already include a[built-in Helm repository]({{site.baseurl}}/docs/new-helm/managed-helm-repository/). Using external Helm repositories is optional.
1212

1313
##Adding an external Helm repository
14+
1415
By default, we show you charts from the[official Helm repository](https://github.com/kubernetes/charts){:target="_blank"} but you can easily add your own:
1516

1617
In the "Helm Charts" page, click on the "Add Repository" button on the top right.
@@ -19,91 +20,20 @@ In the dialog that opened, name your repository, and specify it's URL. The URL s
1920

2021
{% include image.html
2122
lightbox="true"
22-
file="/images/kubernetes-helm/add-helm-repository.png"
23-
url="/images/kubernetes-helm/add-helm-repository.png"
23+
file="/images/kubernetes-helm/quick-helm-integration.png"
24+
url="/images/kubernetes-helm/quick-helm-integration.png"
2425
alt="Adding a Helm repository"
2526
caption="Adding a Helm repository"
26-
max-width="50%"
27-
%}
28-
29-
If your repository doesn't require authentication, click 'Save' and you are done. To add an authenticated repository keep reading.
30-
31-
In addition to public repositories, we also support connecting to Helm repositories hosted on private authenticated stores.
32-
33-
You connect to a private repository from the same dialog you would connect to a public one, by selecting any of the authentication options, like S3, or CGS.
34-
35-
The bucket URL should be provided with a protocol scheme relevant to the selected provider, for example for S3, the URL would look like`s3://mybucketname`.
36-
37-
The rest of the required parameters varies based on the selected provider (see below)
38-
39-
40-
###Private repository - HTTP
41-
42-
You can connect to your repository using HTTP Basic authentication:
43-
44-
- Add your repo URL as usually with HTTP protocol.
45-
- Supply the User and Password for HTTP Basic authentication.
46-
47-
Variables:
48-
49-
Name|Description
50-
---|---
51-
HELMREPO_USERNAME|The username to authenticate with
52-
HELMREPO_PASSWORD|The password for the username provided
53-
54-
###Private repository - S3
55-
56-
- Add your S3 bucket URL in the following scheme:`s3://bucketname`.
57-
- Supply the AWS authentication variables as you would for the AWS CLI, or the S3 plugin for Helm. See details here:[Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html).
58-
59-
Variables:
60-
61-
Name|Description
62-
---|---
63-
AWS_ACCESS_KEY_ID|ID of the key with permissions for the bucket
64-
AWS_SECRET_ACCESS_KEY|Secret of the key with permissions for the bucket
65-
AWS_DEFAULT_REGION|region where the bucket was created
66-
67-
###Private repository - GCS
68-
69-
- Add your GCS bucket URL in the following scheme:`gs://bucketname`.
70-
- Supply the Google authentication variable as you would for the GCloud CLI, or the GCS plugin for Helm. See details here:[Creating Service Account](https://cloud.google.com/docs/authentication/getting-started).
71-
72-
Variables:
73-
74-
Name|Description
75-
---|---
76-
GOOGLE_APPLICATION_CREDENTIALS_JSON|The JSON content of the service account credentials
77-
78-
79-
###Private repository - Azure
80-
81-
First make sure that you[create the Helm repository](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-helm-repos) in Azure.
82-
83-
Then click*Authenticate*. You will get a permissions dialog for allowing Codefresh to access
84-
the Azure services. Click*Accept*.
85-
86-
>Make sure that you are using an organizational/company Azure account and not a personal one. We are currently working with Microsoft to improve this integration.
87-
88-
{% include image.html
89-
lightbox="true"
90-
file="/images/kubernetes-helm/azure-helm-integration.png"
91-
url="/images/kubernetes-helm/azure-helm-integration.png"
92-
alt="Selecting an Azure Helm repository"
93-
caption="Selecting an Azure Helm repository"
9427
max-width="70%"
9528
%}
9629

97-
Select your Azure subscription on the left drop-down menu and your Helm repository on the right drop-down menu.
98-
99-
>If you are already authenticated to Azure, and cannot find your Helm repository in the list, try revoking access and authenticating again.
100-
101-
The Azure Helm integration is now ready.
30+
If your repository doesn't require authentication, click 'Save' and you are done.
10231

32+
For more details on adding extra Helm repositories see the[Helm integration page]({{site.baseurl}}/docs/integrations/helm/).
10333

10434
##Using a Helm Repository in a Codefresh pipeline
10535

106-
Once connected,the private Helm repository context can be injected into pipelines by selecting "Import from shared configuration" (under "Environment Variables" section) and selecting the name of the repository.
36+
Once connected,any Helm repository context can be injected into pipelines by selecting "Import from shared configuration" (under "Environment Variables" section) and selecting the name of the repository.
10737
The repository settings will be injected as environment variables into the pipeline so you can use them as you wish.
10838

10939
{% include image.html
@@ -160,7 +90,9 @@ You can also install Helm releases from [any Helm environment board]({{site.base
16090
##What to read next
16191

16292
*[Using Helm in a Codefresh pipeline]({{site.baseurl}}/docs/new-helm/using-helm-in-codefresh-pipeline/)
93+
*[Helm Integration]({{site.baseurl}}/docs/integrations/helm/)
16394
*[Helm Dashboard]({{site.baseurl}}/docs/new-helm/helm-releases-management)
16495
*[Helm Promotion boards]({{site.baseurl}}/docs/new-helm/helm-environment-promotion)
96+
*[Helm best practices]({{site.baseurl}}/docs/new-helm/helm-best-practices/)
16597

16698

‎_docs/whats-new/whats-new.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ toc: true
2525
- Default SSO provider -[documentation]({{site.baseurl}}/docs/administration/single-sign-on/sso-setup-oauth2/#setting-a-default-provider)
2626
- Codefresh runner now has a dry run option -[documentation]({{site.baseurl}}/docs/administration/codefresh-runner/#inspecting-the-manifests-before-they-are-installed)
2727
- Connect to Azure Kubernetes with a service principal -[documentation]({{site.baseurl}}/docs/deploy-to-kubernetes/add-kubernetes-cluster/#adding-an-aks-cluster-with-a-service-principal)
28+
- Connect to an Azure Helm repository with a service principal -[documentation]({{site.baseurl}}/docs/integrations/helm/#private-helm-repository---azure-with-service-principal)
2829

2930
###December 2020
3031

21.2 KB
Loading
18 KB
Loading
16.3 KB
Loading
-37.2 KB
Binary file not shown.
19.7 KB
Loading

0 commit comments

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