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

Commitffb9121

Browse files
Separate page for secret management
1 parent7e0581e commitffb9121

File tree

8 files changed

+165
-137
lines changed

8 files changed

+165
-137
lines changed

‎_data/home-content.yml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
localurl:/docs/configure-ci-cd-pipeline/monitoring-pipelines/
2828
-title:Shared Configuration
2929
localurl:/docs/configure-ci-cd-pipeline/shared-configuration/
30-
-title:Secrets Storage
30+
-title:Using secrets
3131
new:true
3232
localurl:/docs/configure-ci-cd-pipeline/secrets-store/
3333
-title:Pipeline caching
@@ -213,13 +213,15 @@
213213
localurl:/docs/integrations/google-cloud/
214214
-title:Docker Registries
215215
localurl:/docs/integrations/docker-registries/
216+
-title:Secret Storage
217+
new:true
218+
localurl:/docs/integrations/secret-storage/
216219
-title:Argo CD
217220
new:true
218221
localurl:/docs/integrations/argo-cd/
219222
-title:Jenkins integration/migration
220223
localurl:/docs/integrations/jenkins-integration/
221-
-title:GitHub Actions
222-
localurl:/docs/integrations/github-actions/
224+
223225
-title:Codefresh API
224226
localurl:/docs/integrations/codefresh-api/
225227

‎_data/nav.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
url:"/cron-triggers"
3737
-title:"Monitoring Pipelines"
3838
-title:"Shared Configuration"
39-
-title:Secrets Storage
39+
-title:Using Secrets
4040
url:"/secrets-store"
4141
-title:"Caching"
4242
url:"/pipeline-caching"
@@ -410,6 +410,8 @@
410410
url:"/digital-ocean-container-registry"
411411
-title:"Other Registries"
412412
url:"/other-registries"
413+
-title:Secret Storage
414+
url:"/secret-storage"
413415
-title:ArgoCD Integration
414416
url:"/argo-cd"
415417
-title:Jenkins Integration

‎_docs/configure-ci-cd-pipeline/secrets-store.md‎

Lines changed: 7 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,142 +1,15 @@
11
---
2-
title:"Secrets Storage"
3-
description:"Manage Kubernetes secretswith Codefresh"
2+
title:"Using secrets"
3+
description:"Use Kubernetes secretsin Codefresh"
44
group:configure-ci-cd-pipeline
55
toc:true
66
---
77

8-
Codefresh has added the additional ability to resolve variables storing secrets from remote sources.
9-
10-
This allows you to keep sensitive data on your cluster, and for Codefresh to request it during pipeline execution on user's demand.
11-
12-
Secret-Store is an additional context in Codefresh, which can be created, updated, deleted, etc, using the Codefresh CLI:`codefresh create context secret-store --help`.
13-
14-
At the moment, we support two types of secret storage: Kubernetes (SAAS version) and Runtime-Kubernetes (hybrid deployments).
8+
Once you have[connected Codefresh to your secrets storage]({{site.baseurl}}/docs/integrations/secret-storage/), you can use them in any pipeline or GUI screen.
159

1610
>Note: This feature is for Enterprise accounts only.
1711
18-
##Prerequisites (for Kubernetes secret store)
19-
20-
You need to have your Kubernetes cluster[connected to Codefresh]({{site.baseurl}}/docs/deploy-to-kubernetes/add-kubernetes-cluster/).
21-
(this is only for the Kubernetes type secret store, for runtime-kubernetes[hybrid installation]({{site.baseurl}}/docs/administration/behind-the-firewall/), this is not required)
22-
23-
##Create a Secret
24-
25-
Create your secret in Kubernetes, i.e.
26-
27-
```
28-
kubectl create secret generic my-secret --from-literal=key1=supersecret
29-
```
30-
31-
```
32-
kubectl create configmap my-config-map --from-literal=key1=config1
33-
```
34-
35-
##Kubernetes Secret Store (SAAS Version)
36-
37-
###Using the Codefresh UI
38-
39-
On the left-hand panel, navigate to**Account Settings** >**Integrations** >**Secret Store** and select**Configure**.
40-
41-
Click on**Add Provider** and select**Kubernetes secret store**.
42-
43-
For**Kubernetes** secret store, you will need to define out the following fields:
44-
45-
{% include
46-
image.html
47-
lightbox="true"
48-
file="/images/secrets-ui-view.png"
49-
url="/images/secrets-ui-view.png"
50-
alt="Kubernetes Secret Store"
51-
caption="Kubernetes Secret Store"
52-
max-width="80%"
53-
%}
54-
55-
- Name: a unique name given to your context, which will be referenced in`codefresh.yaml` later.
56-
- Cluster: the name of the cluster as it is configured in Codefresh
57-
- Namespace: the namespace where the secret exists
58-
- Resource name: the name of the secret
59-
60-
You can toggle between ConfigMap or Secret, and also toggle the accessibility for users on this account.
61-
62-
###Using the Codefresh CLI
63-
64-
To create a secret store context for**Kubernetes**, run:
65-
66-
```
67-
codefresh create context secret-store kubernetes "$NAME_IN_CODEFRESH" --cluster "$CLUSTER" --namespace "$NAMESPACE" --resource-type "$TYPE" --resource-name ”$NAME”
68-
```
69-
70-
or, for our example:
71-
72-
```
73-
codefresh create context secret-store kubernetes "test" --cluster "anna-demo@FirstKubernetes" --namespace "default" --resource-type secret --resource-name "my-secret"
74-
```
75-
76-
Where:
77-
78-
-`$NAME_IN_CODEFRESH` is a unique name given to your context, which will be referenced in`codefresh.yaml` later.
79-
-`$CLUSTER` is the name of the cluster as it is configured in Codefresh
80-
-`$NAMESPACE` is the Kubernetes namespace
81-
-`$TYPE` is of either`secret` or`configmap`
82-
- if`secret`, data will be base64 decoded during resolution
83-
- if`configmap`, data will be replaced as is
84-
-`$RESOURCE_NAME` is the name of the secret (optional)
85-
86-
##Runtime Secret Store (Hybrid Installation)
87-
88-
If you are using the[hybrid installation]({{site.baseurl}}/docs/administration/behind-the-firewall/) of Codefresh with the[Runner]({{site.baseurl}}/docs/administration/codefresh-runner/)) you can also store secrets on your own runtime.
89-
90-
###Using the Codefresh UI
91-
92-
On the left-hand panel, navigate to**Account Settings** >**Integrations** >**Secret Store** and select**Configure**.
93-
94-
Click on**Add Provider** and select**Runtime secret store**.
95-
96-
For**Runtime** secret store, you need to define the following fields:
97-
98-
{% include
99-
image.html
100-
lightbox="true"
101-
file="/images/secrets-ui-view2.png"
102-
url="/images/secrets-ui-view2.png"
103-
alt="Runtime Secret Store"
104-
caption="Runtime Secret Store"
105-
max-width="80%"
106-
%}
107-
108-
- Name: a unique name given to your context, which will be referenced in`codefresh.yaml` later.
109-
- Resource name: the name of the secret
110-
- Runtime environment: select from the dropdown any[runtime environments you have installed]({{site.baseurl}}/docs/enterprise/codefresh-runner/).
111-
112-
You can toggle between ConfigMap or Secret, and also toggle the accessibility for users on this account.
113-
114-
###Using the Codefresh CLI
115-
116-
To create a secret store context for**Runtime-Kubernetes** environments ([behind the firewall]({{site.baseurl}}/docs/enterprise/codefresh-runner/)), run:
117-
118-
```
119-
codefresh create context secret-store kubernetes-runtime "$NAME_IN_CODEFRESH" --runtime "$RUNTIME_NAME" --resource-type "$TYPE" --resource-name ”$NAME”
120-
```
121-
122-
or, for our example:
123-
124-
```
125-
codefresh create context secret-store kubernetes-runtime "test" --runtime "gke_firstkubernetes-176201_us-central1-a_anna-demo" --resource-type secret --resource-name "my-secret"
126-
```
127-
128-
Where:
129-
130-
-`$NAME_IN_CODEFRESH` is a unique name given to your context, which will be referenced in`codefresh.yaml` later.
131-
-`$CLUSTER` is the name of the cluster as it is configured in Codefresh
132-
-`$NAMESPACE` is the Kubernetes namespace
133-
-`$TYPE` is of either`secret` or`configmap`
134-
- if`secret`, data will be base64 decoded during resolution
135-
- if`configmap`, data will be replaced as is
136-
-`$RESOURCE_NAME` is the name of the secret (optional)
137-
-`$RUNTIME_NAME` is the name of the run-time environment to be configured as secret store. If not set,*any* runtime-environment will be considered.
138-
139-
##Usage
12+
##Using secrets in pipelines
14013

14114
The syntax for using the secret is {% raw %}`${{secrets.NAME_IN_CODEFRESH.KEY}}`{% endraw %}.
14215

@@ -150,8 +23,8 @@ Define it as a pipeline variable:
15023
{% include
15124
image.html
15225
lightbox="true"
153-
file="/images/secrets-pipeline-var.png"
154-
url="/images/secrets-pipeline-var.png"
26+
file="/images/pipeline/secrets/secrets-pipeline-var.png"
27+
url="/images/pipeline/secrets/secrets-pipeline-var.png"
15528
alt="Secrets Pipeline Variable"
15629
caption="Secrets stored in Pipeline Variable"
15730
max-width="80%"
@@ -189,6 +62,7 @@ steps:
18962
{% endraw %}
19063
{% endhighlight %}
19164

65+
19266
##What to Read Next
19367

19468
*[Shared Configuration]({{site.baseurl}}/docs/configure-ci-cd-pipeline/shared-configuration/)
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
title:"Secret Storage"
3+
description:"Manage Kubernetes secrets with Codefresh"
4+
group:integrations
5+
toc:true
6+
---
7+
8+
Codefresh has added the additional ability to resolve variables storing secrets from remote sources.
9+
10+
This allows you to keep sensitive data on your cluster, and for Codefresh to request it during pipeline execution on user's demand.
11+
12+
Secret-Store is an additional context in Codefresh, which can be created, updated, deleted, etc, using the Codefresh CLI:`codefresh create context secret-store --help`.
13+
14+
At the moment, we support two types of secret storage: Kubernetes (SAAS version) and Runtime-Kubernetes (hybrid deployments).
15+
16+
>Note: This feature is for Enterprise accounts only.
17+
18+
##Prerequisites (for Kubernetes secret store)
19+
20+
You need to have your Kubernetes cluster[connected to Codefresh]({{site.baseurl}}/docs/deploy-to-kubernetes/add-kubernetes-cluster/).
21+
(this is only for the Kubernetes type secret store, for runtime-kubernetes[hybrid installation]({{site.baseurl}}/docs/administration/behind-the-firewall/), this is not required)
22+
23+
###Create a Kubernetes Secret
24+
25+
Create your secret in Kubernetes, i.e.
26+
27+
```
28+
kubectl create secret generic my-secret --from-literal=key1=supersecret
29+
```
30+
31+
```
32+
kubectl create configmap my-config-map --from-literal=key1=config1
33+
```
34+
35+
##Kubernetes Secret Store (SAAS Version)
36+
37+
Kubernetes secrets the native secrets supported by a cluster.
38+
39+
###Using the Codefresh UI
40+
41+
On the left-hand panel, navigate to**Account Settings** >**Integrations** >**Secret Store** and select**Configure**.
42+
43+
Click on**Add Provider** and select**Kubernetes secret store**.
44+
45+
For**Kubernetes** secret store, you will need to define out the following fields:
46+
47+
{% include
48+
image.html
49+
lightbox="true"
50+
file="/images/integrations/secret-storage/secrets-ui-view.png"
51+
url="/images/integrations/secret-storage/secrets-ui-view.png"
52+
alt="Kubernetes Secret Store"
53+
caption="Kubernetes Secret Store"
54+
max-width="80%"
55+
%}
56+
57+
- Name: a unique name given to your context, which will be referenced in`codefresh.yaml` later.
58+
- Cluster: the name of the cluster as it is configured in Codefresh
59+
- Namespace: the namespace where the secret exists
60+
- Resource name: the name of the secret
61+
62+
You can toggle between ConfigMap or Secret, and also toggle the accessibility for users on this account.
63+
64+
###Using the Codefresh CLI
65+
66+
To create a secret store context for**Kubernetes**, run:
67+
68+
```
69+
codefresh create context secret-store kubernetes "$NAME_IN_CODEFRESH" --cluster "$CLUSTER" --namespace "$NAMESPACE" --resource-type "$TYPE" --resource-name ”$NAME”
70+
```
71+
72+
or, for our example:
73+
74+
```
75+
codefresh create context secret-store kubernetes "test" --cluster "anna-demo@FirstKubernetes" --namespace "default" --resource-type secret --resource-name "my-secret"
76+
```
77+
78+
Where:
79+
80+
-`$NAME_IN_CODEFRESH` is a unique name given to your context, which will be referenced in`codefresh.yaml` later.
81+
-`$CLUSTER` is the name of the cluster as it is configured in Codefresh
82+
-`$NAMESPACE` is the Kubernetes namespace
83+
-`$TYPE` is of either`secret` or`configmap`
84+
- if`secret`, data will be base64 decoded during resolution
85+
- if`configmap`, data will be replaced as is
86+
-`$RESOURCE_NAME` is the name of the secret (optional)
87+
88+
##Runtime Secret Store (Hybrid Installation)
89+
90+
If you are using the[hybrid installation]({{site.baseurl}}/docs/administration/behind-the-firewall/) of Codefresh with the[Runner]({{site.baseurl}}/docs/administration/codefresh-runner/)) you can also store secrets on your own runtime.
91+
92+
###Using the Codefresh UI
93+
94+
On the left-hand panel, navigate to**Account Settings** >**Integrations** >**Secret Store** and select**Configure**.
95+
96+
Click on**Add Provider** and select**Runtime secret store**.
97+
98+
For**Runtime** secret store, you need to define the following fields:
99+
100+
{% include
101+
image.html
102+
lightbox="true"
103+
file="/images/integrations/secret-storage/secrets-ui-view2.png"
104+
url="/images/integrations/secret-storage/secrets-ui-view2.png"
105+
alt="Runtime Secret Store"
106+
caption="Runtime Secret Store"
107+
max-width="80%"
108+
%}
109+
110+
- Name: a unique name given to your context, which will be referenced in`codefresh.yaml` later.
111+
- Resource name: the name of the secret
112+
- Runtime environment: select from the dropdown any[runtime environments you have installed]({{site.baseurl}}/docs/enterprise/codefresh-runner/).
113+
114+
You can toggle between ConfigMap or Secret, and also toggle the accessibility for users on this account.
115+
116+
###Using the Codefresh CLI
117+
118+
To create a secret store context for**Runtime-Kubernetes** environments ([behind the firewall]({{site.baseurl}}/docs/enterprise/codefresh-runner/)), run:
119+
120+
```
121+
codefresh create context secret-store kubernetes-runtime "$NAME_IN_CODEFRESH" --runtime "$RUNTIME_NAME" --resource-type "$TYPE" --resource-name ”$NAME”
122+
```
123+
124+
or, for our example:
125+
126+
```
127+
codefresh create context secret-store kubernetes-runtime "test" --runtime "gke_firstkubernetes-176201_us-central1-a_anna-demo" --resource-type secret --resource-name "my-secret"
128+
```
129+
130+
Where:
131+
132+
-`$NAME_IN_CODEFRESH` is a unique name given to your context, which will be referenced in`codefresh.yaml` later.
133+
-`$CLUSTER` is the name of the cluster as it is configured in Codefresh
134+
-`$NAMESPACE` is the Kubernetes namespace
135+
-`$TYPE` is of either`secret` or`configmap`
136+
- if`secret`, data will be base64 decoded during resolution
137+
- if`configmap`, data will be replaced as is
138+
-`$RESOURCE_NAME` is the name of the secret (optional)
139+
-`$RUNTIME_NAME` is the name of the run-time environment to be configured as secret store. If not set,*any* runtime-environment will be considered.
140+
141+
##Using the secrets
142+
143+
Once Codefresh is linked to your secrets you can use them either in pipelines or any relevant section in the Codefresh GUI. See[Using secrets]({{site.baseurl}}/docs/configure-ci-cd-pipeline/secrets-store/) for the details.
144+
145+
##What to Read Next
146+
147+
*[Shared Configuration]({{site.baseurl}}/docs/configure-ci-cd-pipeline/shared-configuration/)
148+
*[Git integration]({{site.baseurl}}/docs/integrations/git-providers/)
149+
*[Kubernetes integration]({{site.baseurl}}/docs/integrations/kubernetes/)
150+
*[Container registry integration]({{site.baseurl}}/docs/integrations/docker-registries/)
File renamed without changes.
15.9 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp