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

Commitb9e4482

Browse files
committed
Update cd example topics
Fixes after QA of cd examples
1 parentda06d6a commitb9e4482

File tree

9 files changed

+49
-49
lines changed

9 files changed

+49
-49
lines changed

‎_docs/example-catalog/cd-examples/deploy-to-heroku.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This tutorial will cover two examples, depending on your use case. If you are no
1414

1515
##Example Django Application
1616

17-
You can find the example project on[GitHub](https://github.com/codefresh-contrib/heroku-python-django-sample-app).
17+
You can find the example project on[GitHub](https://github.com/codefresh-contrib/heroku-python-django-sample-app){:target="\_blank"}.
1818

1919
The repository contains a Django starter project with the following commands:
2020

@@ -28,7 +28,7 @@ Once launched the application presents the Django starter page at localhost:8000
2828

2929
###Prerequisites
3030

31-
- A[freeCodefresh account]({{site.baseurl}}/docs/administration/account-user-management/#create-a-codefresh-account/)
31+
- A[Codefresh account]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/)
3232
- A[free Heroku account](https://signup.heroku.com){:target="\_blank"}
3333
- A Heroku API token (you can find this under**Account Settings** and then scrolling down, you will find the API Key)
3434

@@ -47,7 +47,7 @@ max-width="100%"
4747

4848
You should be able to copy and paste this YAML in the in-line editor of the Codefresh UI. It will automatically clone the project for you.
4949

50-
Note that you need to change the environment variables in the deploy stage to your respective values. You can do thisdirectly[in the YAML itself]({{site.baseurl}}/docs/how-to-guides/migrating-from-travis-ci/#environment-variables), orthrough the Codefresh UI. Navigate to the in-line editor, and to the right you will find a tablebeled**Variables**.
50+
Note that you need to change the environment variables in the deploy stage to your respective values. You can do this through the Codefresh UI. Navigate to the in-line editor, and to the right you will find a tablabeled**Variables**.
5151

5252
{% include image.html
5353
lightbox="true"
@@ -100,13 +100,13 @@ The above pipeline has the following steps:
100100

101101
1. A[git-clone]({{site.baseurl}}/docs/pipelines/steps/git-clone/) step that clones the main repository
102102
2. A[freestyle step]({{site.baseurl}}/docs/pipelines/steps/freestyle/) that installs dependencies and runs the unit tests
103-
3. A freestyle step that deploys the application to Heroku using the heroku-deployer plugin from the[Step Marketplace](https://codefresh.io/steps/step/heroku-deployer)
103+
3. A freestyle step that deploys the application to Heroku using the heroku-deployer plugin from the[Step Marketplace](https://codefresh.io/steps/step/heroku-deployer){:target="\_blank"}.
104104

105105
##Pipeline Example#2: Deploy a Docker Image to Heroku
106106

107107
This example differs from the plugin usage, as it deploys a built Docker image to Heroku.
108108

109-
Note that you need to change the environment variables to your respective values. You can do thisdirectly[in the YAML itself]({{site.baseurl}}/docs/how-to-guides/migrating-from-travis-ci/#environment-variables), orthrough the Codefresh UI. Navigate to the in-line editor, and to the right you will find a tablebeled**Variables**.
109+
Note that you need to change the environment variables to your respective values. You can do this through the Codefresh UI. Navigate to the in-line editor, and to the right you will find a tablabeled**Variables**.
110110

111111
{% include image.html
112112
lightbox="true"
@@ -119,10 +119,10 @@ max-width="100%"
119119

120120
##Prerequisites
121121

122-
- A[freeCodefresh account]({{site.baseurl}}/docs/administration/account-user-management/#create-a-codefresh-account/)
122+
- A[Codefresh account]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/)
123123
- A[free Heroku account](https://signup.heroku.com){:target="\_blank"}
124124
- An empty repository already created in Heroku using the`heroku create <IMAGE_NAME>` command
125-
- A Heroku registry[connected to Codefresh]({{site.baseurl}}/docs/docker-registries/external-docker-registries/other-registries/#heroku-registries)
125+
- A Heroku registry[connected to Codefresh]({{site.baseurl}}/docs/integrations/docker-registries/other-registries/#heroku-registries)
126126
- A Heroku API token (you can find this under**Account Settings** and then scrolling down, you will find the API Key)
127127

128128
###Create the pipeline
@@ -211,4 +211,4 @@ The pipeline does the following:
211211

212212

213213
##Related articles
214-
[CI/CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
214+
[CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)

‎_docs/example-catalog/cd-examples/deploy-with-kustomize.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ redirect_from:
88
toc:true
99
---
1010

11-
[Kustomize](https://kustomize.io) is a tool included with kubectl 1.14 that "lets you customize raw, template-free YAML files for multiple purposes, leaving the original YAML untouched and usable as is."
11+
[Kustomize](https://kustomize.io){:target="\_blank"} is a tool included with kubectl 1.14 that "lets you customize raw, template-free YAML files for multiple purposes, leaving the original YAML untouched and usable as is."
1212

1313
Kustomize is more of an overlay engine, as opposed to a templating engine. You create a base configuration and overlays. Your overlays contain a*kustomization.yaml* file, and any variants/changes are applied over top of the base configuration. Kustomize does not use templates at all.
1414

@@ -68,7 +68,7 @@ data:
6868
mysqlDB: "prod-mysql.example.com:3306"
6969
```
7070

71-
In addition, for the production environment, the number of replicas will be overlayed to 3 instead of1 (as [definedinthebasedeployment](https://github.com/codefresh-contrib/kustomize-sample-app/blob/32e683f82940de0bf2de2da40fa6b150e2b24b23/base/deployment.yaml#L8)){:target="\_blank"}.
71+
In addition, for the production environment, the number of replicas will be overlayed to 3 instead of1 (as [definedinthebasedeployment](https://github.com/codefresh-contrib/kustomize-sample-app/blob/32e683f82940de0bf2de2da40fa6b150e2b24b23/base/deployment.yaml#L8){:target="\_blank"}).
7272

7373
`overlays/production/deployment.yaml`
7474
```yaml
@@ -82,9 +82,8 @@ spec:
8282

8383
##Prerequisites
8484

85-
-A [freeCodefreshaccount]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account)
86-
<!--change once moved-->
87-
- A Kubernetes cluster [connected to your Codefresh account](https://codefresh.io/docs/docs/integrations/kubernetes/#connect-a-kubernetes-cluster)
85+
-A [freeCodefreshaccount]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/)
86+
- A Kubernetes cluster [connected to your Codefresh account]({{site.baseurl}}/docs/integrations/kubernetes/#connect-a-kubernetes-cluster)
8887

8988
##Create the staging environment pipeline
9089

@@ -239,8 +238,8 @@ max-width="100%"
239238

240239

241240
##Related articles
242-
[CI/CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
243-
[Deployment optionstoKubernetes]({{site.baseurl}}/docs/deployments/kubernetes/deployment-options-to-kubernetes)
241+
[CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
242+
[Deployment optionsforKubernetes]({{site.baseurl}}/docs/deployments/kubernetes/deployment-options-to-kubernetes)
244243
[Running custom kubectl commands]({{site.baseurl}}/docs/deployments/kubernetes/custom-kubectl-commands/)
245244
[Deploy withHelm]({{site.baseurl}}/docs/example-catalog/cd-examples/helm/)
246245

‎_docs/example-catalog/cd-examples/docker-swarm.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ The `SPLIT_CHAR` variable should hold the replacement character that was used fo
9191

9292
{% include image.html
9393
lightbox="true"
94-
file="/images/2f1884a-codefresh_env_vars.png"
95-
url="/images/2f1884a-codefresh_env_vars.png"
94+
file="/images/examples/docker-swarm/codefresh_env_vars.png"
95+
url="/images/examples/docker-swarm/codefresh_env_vars.png"
9696
alt="Docker Swarm build parameters"
9797
caption="Docker Swarm build parameters"
9898
max-width="70%"
@@ -211,10 +211,10 @@ steps:
211211
{% endraw %}
212212
{% endhighlight %}
213213

214-
The values of`MY_REGISTRY`,`MY_REGISTRY_USER` and`MY_REGISTRY_PASSWORD` depend upon the type of[your connected registry]({{site.baseurl}}/docs/integration/docker-registries/).
214+
The values of`MY_REGISTRY`,`MY_REGISTRY_USER` and`MY_REGISTRY_PASSWORD` depend upon the type of[your connected registry]({{site.baseurl}}/docs/integrations/docker-registries/).
215215

216216
##Related articles
217-
[CI/CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
217+
[CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
218218
[Codefresh YAML for pipeline definitions]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
219219
[Steps in pipelines]({{site.baseurl}}/docs/pipelines/steps/)
220220
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)

‎_docs/example-catalog/cd-examples/helm.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,28 @@ toc: true
1212
Codefresh has comprehensive support for Helm:
1313

1414
* Free[built-in Helm repository]({{site.baseurl}}/docs/deployments/helm/managed-helm-repository/) with each Codefresh account
15-
*[Helm chart dashboard]({{site.baseurl}}/docs/docs/deployments/add-helm-repository/) to track your charts
16-
*[Helm Release dashboard]({{site.baseurl}}/docs/docs/deployments/helm-releases-management/) to view your deployments
15+
*[Helm chart dashboard]({{site.baseurl}}/docs/deployments/helm/helm-charts-and-repositories/) to track your charts
16+
*[Helm Release dashboard]({{site.baseurl}}/docs/deployments/helm/helm-releases-management/) to view your deployments
1717
*[Environment dashsboard]({{site.baseurl}}/docs/deployments/kubernetes/environment-dashboard/) to view Helm releases
18-
*[Helm promotion dashboard]({{site.baseurl}}/docs/deployments/helm-environment-promotion/) to promote Helm releases
18+
*[Helm promotion dashboard]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion/) to promote Helm releases
1919
* Add any external Helm repository on any other cloud provider
2020

21-
Codefresh also provides a[pipeline step]({{site.baseurl}}/docs/new-helm/using-helm-in-codefresh-pipeline/) for deploying with Helm.
21+
Codefresh also provides a[pipeline step]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/) for deploying with Helm.
2222

23-
For more insights on Helm charts see also our[Helm best practices]({{site.baseurl}}/docs/new-helm/helm-best-practices/) guide.
23+
For more insights on Helm charts see also our[Helm best practices]({{site.baseurl}}/docs/ci-cd-guides/helm-best-practices/) guide.
2424

2525

2626
##The example Helm project
2727

28-
You can see the example project at[https://github.com/codefresh-contrib/helm-sample-app](https://github.com/codefresh-contrib/helm-sample-app){:target=\_blank"}. The repository contains a simple Go application, a Dockerfile and an example chart.
28+
You can see the example project at[https://github.com/codefresh-contrib/helm-sample-app](https://github.com/codefresh-contrib/helm-sample-app){:target="\_blank"}. The repository contains a simple Go application, a Dockerfile and an example chart.
2929

3030

3131
##Prerequisites
3232

33-
[At least one Kubernetes cluster]({{site.baseurl}}/docs/integrations/kubernetes/#connect-a-kubernetes-cluster/) in your Codefresh account.
33+
[At least one Kubernetes cluster]({{site.baseurl}}/docs/integrations/kubernetes/#connect-a-kubernetes-cluster) in your Codefresh account.
3434

35-
>Notice that if you still use Helm 2 you should also have installed the server side of Helm 2 (Tiller) using`helm init`. This command is best run from the cloud console of your cluster. The respective pipelines of this guide are in the[helm-2 branch](https://github.com/codefresh-contrib/helm-sample-app/tree/helm-2){:target=\_blank"}.
35+
<!--- ask Kostis if we need this?>
36+
>Notice that if you still use Helm 2 you should also have installed the server side of Helm 2 (Tiller) using `helm init`. This command is best run from the cloud console of your cluster. The respective pipelines of this guide are in the [helm-2 branch](https://github.com/codefresh-contrib/helm-sample-app/tree/helm-2){:target=\_blank"}.-->
3637

3738

3839

@@ -101,11 +102,11 @@ This pipeline does the following:
101102

102103
1. Clones the source code through a[Git clone step]({{site.baseurl}}/docs/pipelines/steps/git-clone/)
103104
1. Builds a docker image through a[build step]({{site.baseurl}}/docs/pipelines/steps/build/)
104-
1. Deploys the Helm chart to a cluster named`my-demo-k8s-cluster` using the Helm step[from the Step Marketplace](https://codefresh.io/steps/step/helm){:target=\_blank"}.
105+
1. Deploys the Helm chart to a cluster named`my-demo-k8s-cluster` using the Helm step[from the Step Marketplace](https://codefresh.io/steps/step/helm){:target="\_blank"}.
105106

106-
In this example,`charts/helm-example` refers to the[filesystem location in the code](https://github.com/codefresh-contrib/helm-sample-app/tree/master/charts/helm-example){:target=\_blank"} that was just checked out.
107+
In this example,`charts/helm-example` refers to the[filesystem location in the code](https://github.com/codefresh-contrib/helm-sample-app/tree/master/charts/helm-example){:target="\_blank"} that was just checked out.
107108

108-
The deployment will be visible in the[Helm releases dashboard]({{site.baseurl}}/docs/new-helm/helm-releases-management/).
109+
The deployment will be visible in the[Helm releases dashboard]({{site.baseurl}}/docs/deployments/helm/helm-releases-management/).
109110

110111
{% include image.html
111112
lightbox="true"
@@ -123,7 +124,7 @@ If you want to run this example yourself, make sure to edit the chart and put yo
123124
It is recommended to use a Helm repository to store your chart before deploying it. This way you know what is deployed in your clusters
124125
and you can also reuse charts in other installations.
125126

126-
First of all you need to import in your pipeline from the[shared configuration]({{site.baseurl}}/docs/pipelines/shared-configuration/) the settings for the internal Helm repository (or any other external repository that you have setup in Codefresh).
127+
First of all you need to import in your pipeline from the[shared configuration]({{site.baseurl}}/docs/pipelines/configuration/shared-configuration/) the settings for the internal Helm repository (or any other external repository that you have setup in Codefresh).
127128
This will make available the internal Helm repository to your pipeline so that it can push/pull Helm charts from it.
128129

129130
{% include image.html
@@ -205,7 +206,7 @@ steps:
205206
{% endhighlight %}
206207

207208

208-
After you finish running your pipeline, not only the deployment will take place, but you will also see your chart in your[Helm Chart dashboard]({{site.baseurl}}/docs/new-helm/add-helm-repository/):
209+
After you finish running your pipeline, not only the deployment will take place, but you will also see your chart in your[Helm Chart dashboard]({{site.baseurl}}/docs/deployments/helm/helm-charts-and-repositories/):
209210

210211
{% include image.html
211212
lightbox="true"
@@ -220,7 +221,7 @@ It is also possible to [run your own Helm commands]({{site.baseurl}}/docs/deploy
220221

221222

222223
##Related articles
223-
[CI/CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
224+
[CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
224225
[Codefresh YAML for pipeline definitions]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
225226
[Steps in pipelines]({{site.baseurl}}/docs/pipelines/steps/)
226227
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)

‎_docs/example-catalog/cd-examples/nomad.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ toc: true
1111
Even though Codefresh has great support for Kubernetes and Helm deployments, there is no lock-in on using just Kubernetes. Codefresh can deploy on any infrastructure.
1212

1313

14-
[Nomad](https://www.nomadproject.io/){:target=\_blank"} is an alternative scheduling platform from Hashicorp. It supports docker containers (like Kubernetes), but you can also use Nomad to schedule VMs, Java apps, Go apps or any other standalone executable.
14+
[Nomad](https://www.nomadproject.io/){:target="\_blank"} is an alternative scheduling platform from Hashicorp. It supports docker containers (like Kubernetes), but you can also use Nomad to schedule VMs, Java apps, Go apps or any other standalone executable.
1515

1616
There are several public Docker Images with Nomad, so it is very easy to use Codefresh pipelines to deploy to a Nomad cluster.
1717

@@ -25,11 +25,11 @@ caption="Deploying to Nomad with Codefresh"
2525
max-width="80%"
2626
%}
2727

28-
In this example, we will use the image at[https://hub.docker.com/r/djenriquez/nomad](https://hub.docker.com/r/djenriquez/nomad){:target=\_blank"}.
28+
In this example, we will use the image at[https://hub.docker.com/r/djenriquez/nomad](https://hub.docker.com/r/djenriquez/nomad){:target="\_blank"}.
2929

3030
##The example Nomad project
3131

32-
You can see the example project at[https://github.com/codefresh-contrib/nomad-sample-app](https://github.com/codefresh-contrib/nomad-sample-app){:target=\_blank"}. The repository contains a simple job specification that deploys a docker container on nomad cluster.
32+
You can see the example project at[https://github.com/codefresh-contrib/nomad-sample-app](https://github.com/codefresh-contrib/nomad-sample-app){:target="\_blank"}. The repository contains a simple job specification that deploys a docker container on nomad cluster.
3333

3434

3535
Here is the whole job file:
@@ -124,13 +124,13 @@ job "example-job" {
124124
{% endraw %}
125125
{% endhighlight %}
126126

127-
Notice that the job specification has several[Codefresh variables]({{site.baseurl}}/docs/pipelines/variables/) embedded. We will use[envsubst](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html){:target=\_blank"} in our pipeline to replace
127+
Notice that the job specification has several[Codefresh variables]({{site.baseurl}}/docs/pipelines/variables/) embedded. We will use[envsubst](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html){:target="\_blank"} in our pipeline to replace
128128
them with the correct values.
129129

130130
##Prerequisites
131131

132132
You need to create a Codefresh account and have a Nomad cluster running. You need to decide on how Codefresh will communicate
133-
with the nomad cluster. In this simple example we just use the`NOMAD_ADDR` variable to point the nomad client to our cluster. In a production environment you should use proper[ACL](https://www.nomadproject.io/guides/security/acl.html){:target=\_blank"} and[certificate](https://www.nomadproject.io/guides/security/securing-nomad.html){:target=\_blank"} variables as well.
133+
with the nomad cluster. In this simple example we just use the`NOMAD_ADDR` variable to point the nomad client to our cluster. In a production environment you should use proper[ACL](https://www.nomadproject.io/guides/security/acl.html){:target="\_blank"} and[certificate](https://www.nomadproject.io/guides/security/securing-nomad.html){:target="\_blank"} variables as well.
134134

135135

136136
In this example the Nomad cluster is already setup on a VM at Google cloud.
@@ -221,7 +221,7 @@ max-width="80%"
221221
You can also use[Terraform]({{site.baseurl}}/docs/example-catalog/cd-examples/terraform/) in Codefresh pipelines.
222222

223223
##Related articles
224-
[CI/CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
224+
[CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#cd-examples)
225225
[Codefresh YAML for pipeline definitions]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
226226
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)
227227
[How Codefresh pipelines work]({{site.baseurl}}/docs/pipelines/introduction-to-codefresh-pipelines/)

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp