Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
784 changes: 304 additions & 480 deletions _docs/ci-cd-guides/gitops-deployments.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _docs/ci-cd-guides/progressive-delivery.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ by simply telling the load balancer to move 100% of traffic back to the previous
{% include image.html
lightbox="true"
file="/images/guides/progressive-delivery/04_canary_finished.png"
url="/images/guides/progressive-delivery/04_canary_finished"
url="/images/guides/progressive-delivery/04_canary_finished.png"
alt="Old application version is discarded. Only new version remains."
caption="Old application version is discarded. Only new version remains."
max-width="90%"
Expand Down
2 changes: 1 addition & 1 deletion _docs/deployments/helm/custom-helm-uploads.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ This pipeline references some predefined environment variables such as `GOOGLE_B
For this example, we created a service account with appropriate permissions in Google Cloud, and saved the credentials into `GOOGLE_CREDENTIALS` as a Codefresh Secret. <br>
For more information, see:
[Authenticating with Google services](https://cloud.google.com/storage/docs/authentication#service_accounts){:target="_blank"}
[Codefresh pipeline configuration and secrets]({{site.baseurl}}/pipelines/variables/#user-provided-variables)
[Codefresh pipeline configuration and secrets]({{site.baseurl}}/pipelines/variables/#user-defined-variables)

## Example 2: Push the chart to Chart Museum
Chart Museum is a Helm repository *server* that has an HTTP API, pluggable backends, authentication, and more.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,5 +92,5 @@ Notice that there are no explicit push steps in the pipeline, as all successful
[Git clone step]({{site.baseurl}}/docs/pipelines/steps/git-clone/)
[Build an Image with the Dockerfile in root directory]({{site.baseurl}}/docs/example-catalog/ci-examples/build-an-image-with-the-dockerfile-in-root-directory/)
[Build step in pipelines in pipelines]({{site.baseurl}}/docs/pipelines/steps/build/)
[Build and push an image]({{site.baseurl}}/docs/pipelines/example-catalog/ci-examples/build-and-push-an-image/)
[Build and push an image]({{site.baseurl}}/docs/example-catalog/ci-examples/build-and-push-an-image/)
[Parallel pipelines]({{site.baseurl}}/docs/pipelines/advanced-workflows/)
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You may have a project where the Dockerfile is **not** in the root folder of the

>The source code of the repository is at [https://github.com/codefreshdemo/cf-example-dockerfile-other-location](https://github.com/codefreshdemo/cf-example-dockerfile-other-location){:target="\_blank"}. Feel free to fork it if you want to follow along.

If you don't have a Codefresh account already, you can easily create a free one from the [sign-up page]({{site.baseurl}}/docs/administration/account-user-management/create-a-codefresh-account/).
If you don't have a Codefresh account already, you can easily create a free one from the [sign-up page]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/).


## Building a Dockerfile from a different folder
Expand Down Expand Up @@ -68,7 +68,7 @@ You could also change the Docker build context by editing the `working_directory

## Related articles
[CI/CD pipeline examples]({{site.baseurl}}/docs/example-catalog/examples/#ci-examples)
[Build an Image with the Dockerfile in root directory]({{site.baseurl}}/docs/example-catalog/ci-examples/build-an-image-dockerfile-in-root-directory/)
[Build an Image with the Dockerfile in root directory]({{site.baseurl}}/docs/example-catalog/ci-examples/build-an-image-with-the-dockerfile-in-root-directory/)
[Build an Image from a different Git repository]({{site.baseurl}}/docs/example-catalog/ci-examples/build-an-image-from-a-different-git-repository)
[Build and push an Image]({{site.baseurl}}/docs/example-catalog/ci-examples/build-and-push-an-image)
[Build an Image With build arguments]({{site.baseurl}}/docs/example-catalog/ci-examples/build-an-image-with-build-arguments)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Building a Docker image is one of the basic operations in Codefresh pipelines.

>The source code of the repository is at [https://github.com/codefreshdemo/cf-yml-example-build-dockerfile-inroot](https://github.com/codefreshdemo/cf-yml-example-build-dockerfile-inroot){:target="\_blank"}. Feel free to fork it if you want to follow along.

If you don't have a Codefresh account already, you can easily create a free one from the [sign-up page]({{site.baseurl}}/docs/administration/account-user-management/create-a-codefresh-account/).
If you don't have a Codefresh account already, you can easily create a free one from the [sign-up page]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/).


## Building a Dockerfile from the root folder
Expand Down
2 changes: 1 addition & 1 deletion _docs/example-catalog/ci-examples/fan-in-fan-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can achieve parallelism in your Codefresh pipelines by using the following:

## Prerequisites

- A [Codefresh account]({{site.baseurl}}/_docs/administration/account-user-management/create-codefresh-account/)
- A [Codefresh account]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/)

## Example project

Expand Down
6 changes: 3 additions & 3 deletions _docs/example-catalog/ci-examples/publish-jar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ toc: true

Even though Codefresh has great support for containers, it can still be used for traditional JAR uploads of libraries or applications that are not dockerized yet. In this example we will compile a JAR and upload it to Nexus. The process is the same for Artifactory or any other package manager.

For a Java application with Docker, see the [Gradle]({{site.baseurl}}/docs/learn-by-example/java/gradle/){} or
[Maven example]({{site.baseurl}}/docs/learn-by-example/java/spring-boot-2/).
For a Java application with Docker, see the [Gradle]({{site.baseurl}}/docs/example-catalog/ci-examples/gradle/) or
[Maven example]({{site.baseurl}}/docs/example-catalog/ci-examples/spring-boot-2/).

## The example Java library project

Expand Down Expand Up @@ -104,7 +104,7 @@ You can use the same pipeline for Artifactory or any other compliant Java packag


## Related articles
[Gradle example]({{site.baseurl}}/docs/example-catalog/ci-examples/java/gradle/)
[Gradle example]({{site.baseurl}}/docs/example-catalog/ci-examples/gradle/)
[Spring boot example]({{site.baseurl}}/docs//example-catalog/ci-examples/spring-boot-2/)
[Codefresh YAML for pipeline definitions]({{site.baseurl}}/docs/pipelines/what-is-the-codefresh-yaml/)
[Steps in pipelines]({{site.baseurl}}/docs/pipelines/steps/)
Expand Down
2 changes: 1 addition & 1 deletion _docs/example-catalog/ci-examples/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The first step is a [build step]({{site.baseurl}}/docs/pipelines/steps/build/) n

## Inspecting your Docker image

You can see all your latest [Docker artifacts]({{site.baseurl}}/docs/docker-registries/working-with-docker-registries/#viewing-docker-images) by selecting *Images* from the left sidebar.
You can see all your latest [Docker artifacts]({{site.baseurl}}/docs/ci-cd-guides/working-with-docker-registries/#viewing-docker-images) by selecting *Images* from the left sidebar.


{% include image.html
Expand Down
2 changes: 1 addition & 1 deletion _docs/installation/behind-the-firewall.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,5 +242,5 @@ The cluster where the runner works on should have network connectivity with the
Once your cluster is connected you can use any of the familiar deployment methods such as the [dedicated deploy step]({{site.baseurl}}/docs/deployments/kubernetes/) or [custom kubectl commands]({{site.baseurl}}/docs/deployments/kubernetes/custom-kubectl-commands/).

## Related articles
[Google marketplace integration]({{site.baseurl}}/docs/integrations/ci-integrations/google-marketplace/)
[Google marketplace integration]({{site.baseurl}}/docs/integrations/google-marketplace/)
[Managing your Kubernetes cluster]({{site.baseurl}}/docs/deployments/kubernetes/manage-kubernetes/)
10 changes: 5 additions & 5 deletions _docs/installation/gitops/hybrid-gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -881,7 +881,7 @@ The cluster defined as the default for `kubectl`. If you have more than one Kube
**Access mode**
The access mode for the runtime, which can be one of the following:
* [Tunnel-based]({{site.baseurl}}/docs/installation/runtime-architecture/#tunnel-based-hybrid-gitops-runtime-architecture), for runtimes without ingress controllers. This is the default.
* [Ingress-based]({{site.baseurl}}/docs/getting-started/architecture/#ingress-based-hybrid-gitops-runtime-architecture) for runtimes with ingress contollers.
* [Ingress-based]({{site.baseurl}}/docs/installation/runtime-architecture/#ingress-based-hybrid-gitops-runtime-architecture) for runtimes with ingress contollers.


* CLI wizard: Select the access mode from the list displayed.
Expand Down Expand Up @@ -1285,8 +1285,8 @@ data:


## Related articles
[Add external clusters to Hybrid and Hosted Runtimes]({{site.baseurl}}/docs/installation/managed-cluster/)
[Monitoring & managing GitOps Runtimes]({{site.baseurl}}/docs/installation/monitor-manage-runtimes/)
[Add Git Sources to runtimes]({{site.baseurl}}/docs/installation/git-sources/)
[Add external clusters to Hybrid and Hosted Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
[Monitoring & managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/)
[Add Git Sources to runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
[Shared configuration repo]({{site.baseurl}}/docs/reference/shared-configuration)
[Troubleshoot Hybrid Runtime installation]({{site.baseurl}}/installation/troubleshooting/runtime-issues/)
[Troubleshoot Hybrid Runtime installation]({{site.baseurl}}/docs/troubleshooting/runtime-issues/)
10 changes: 5 additions & 5 deletions _docs/installation/gitops/monitor-manage-runtimes.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ Here is a description of the information in the List View.
|**Type**| The type of GitOps Runtime provisioned, and can be **Hybrid** or **Hosted**. |
|**Cluster/Namespace**| The K8s API server endpoint, as well as the namespace with the cluster. |
|**Modules**| The modules installed based on the type of provisioned Runtime. Hybrid Runtimes include CI amnd CD Ops modules. Hosted runtimes include CD Ops. |
|**Managed Cluster**| The number of managed clusters if any, for the runtime. To view list of managed clusters, select the runtime, and then the **Managed Clusters** tab. To work with managed clusters, see [Adding external clusters to runtimes]({{site.baseurl}}/docs/runtime/managed-cluster).|
|**Managed Cluster**| The number of managed clusters if any, for the runtime. To view list of managed clusters, select the runtime, and then the **Managed Clusters** tab. To work with managed clusters, see [Adding external clusters to runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/).|
|**Version**| The version of the runtime currently installed. **Update Available!** indicates there are later versions of the runtime. To see all the commits to the runtime, mouse over **Update Available!**, and select **View Complete Change Log**.
|**Last Updated**| The most recent update information from the runtime to the Codefresh platform. Updates are sent to the platform typically every few minutes. Longer update intervals may indicate networking issues.|
|**Sync Status**| The health and sync status of the runtime or cluster. {::nomarkdown}<br><ul><li> <img src="../../../images/icons/error.png" display=inline-block> indicates health or sync errors in the runtime, or a managed cluster if one was added to the runtime.</br> The runtime name is colored red.</li> <li><img src="../../../images/icons/cf-sync-status.png" display=inline-block> indicates that the runtime is being synced to the cluster on which it is provisioned.</li></ul> {:/} |
|**Sync Status**| The health and sync status of the runtime or cluster. {::nomarkdown}<br><ul><li> <img src="../../../../images/icons/error.png" display=inline-block> indicates health or sync errors in the runtime, or a managed cluster if one was added to the runtime.</br> The runtime name is colored red.</li> <li><img src="../../../../images/icons/cf-sync-status.png" display=inline-block> indicates that the runtime is being synced to the cluster on which it is provisioned.</li></ul> {:/} |

### Topology view

Expand All @@ -99,9 +99,9 @@ Here is a description of the information in the Topology view.
{: .table .table-bordered .table-hover}
| Topology View Item | Description |
| ------------------------| ---------------- |
|**Runtime** | ![](../../../images/icons/codefresh-runtime.png?display=inline-block) the provisioned Runtime. Hybrid Runtimes display the name of the K8s API server endpoint with the cluster. Hosted Runtimes display 'hosted'. |
|**Cluster** | The local, and managed clusters if any, for the Runtime. {::nomarkdown}<ul><li><img src="../../../images/icons/local-cluster.png" display=inline-block/> indicates the local cluster, always displayed as `in-cluster`. The in-cluster server URL is always set to `https://kubernetes.default.svc/`.</li><li><img src="../../../images/icons/managed-cluster.png" display=inline-block/> indicates a managed cluster.</li> <li> <img src="../../../images/icons/add-cluster.png" display=inline-block/> select to add a new managed cluster.</li></ul> {:/} To view cluster components, select the cluster. To add and work with managed clusters, see [Adding external clusters to runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster). |
|**Health/Sync status** |The health and sync status of the Runtime or cluster. {::nomarkdown}<ul><li><img src="../../../images/icons/error.png" display="inline-block"> indicates health or sync errors in the Runtime, or a managed cluster if one was added to the runtime.</br> The runtime or cluster node is bordered in red and the name is colored red.</li> <li><img src="../../../images/icons/cf-sync-status.png" display=inline-block/> indicates that the Runtime is being synced to the cluster on which it is provisioned.</li></ul> {:/} |
|**Runtime** | ![](../../../../images/icons/codefresh-runtime.png?display=inline-block) the provisioned Runtime. Hybrid Runtimes display the name of the K8s API server endpoint with the cluster. Hosted Runtimes display 'hosted'. |
|**Cluster** | The local, and managed clusters if any, for the Runtime. {::nomarkdown}<ul><li><img src="../../../../images/icons/local-cluster.png" display=inline-block/> indicates the local cluster, always displayed as `in-cluster`. The in-cluster server URL is always set to `https://kubernetes.default.svc/`.</li><li><img src="../../../../images/icons/managed-cluster.png" display=inline-block/> indicates a managed cluster.</li> <li> <img src="../../../../images/icons/add-cluster.png" display=inline-block/> select to add a new managed cluster.</li></ul> {:/} To view cluster components, select the cluster. To add and work with managed clusters, see [Adding external clusters to runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster). |
|**Health/Sync status** |The health and sync status of the Runtime or cluster. {::nomarkdown}<ul><li><img src="../../../../images/icons/error.png" display="inline-block"> indicates health or sync errors in the Runtime, or a managed cluster if one was added to the runtime.</br> The runtime or cluster node is bordered in red and the name is colored red.</li> <li><img src="../../../../images/icons/cf-sync-status.png" display=inline-block/> indicates that the Runtime is being synced to the cluster on which it is provisioned.</li></ul> {:/} |
|**Search and View options** | {::nomarkdown}<ul><li>Find a Runtime or its clusters by typing part of the Runtime/cluster name, and then navigate to the entries found. </li> <li>Topology view options: Resize to window, zoom in, zoom out, full screen view.</li></ul> {:/}|

## Managing provisioned GitOps Runtimes
Expand Down
2 changes: 1 addition & 1 deletion _docs/installation/runtime-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The most important components are the following:

**Pipeline execution environment**: The Codefresh engine component is responsible for taking pipeline definitions and running them in managed Kubernetes clusters by automatically launching the Docker containers that each pipeline needs for its steps.

**External actors**. Codefresh offers a [public API]({{site.baseurl}}/docs/integrations/ci-integrations/codefresh-api/) that is consumed both by the Web user interface and the <!--should i differentiate between the CI Cli and GitOps CLI -->[Codefresh CLI](https://codefresh-io.github.io/cli/){:target="\_blank"}. The API is also available for any custom integration with external tools or services.
**External actors**. Codefresh offers a [public API]({{site.baseurl}}/docs/integrations/codefresh-api/) that is consumed both by the Web user interface and the <!--should i differentiate between the CI Cli and GitOps CLI -->[Codefresh CLI](https://codefresh-io.github.io/cli/){:target="\_blank"}. The API is also available for any custom integration with external tools or services.

### Runner topology

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,13 +158,13 @@ max-width="40%"
{% include image.html
lightbox="true"
file="/images/integrations/docker-registries/ecr/ecr-manual-promote-settings.png"
url="/images/f2b0ec5-ecr3.png"
url="/images/integrations/docker-registries/ecr/ecr-manual-promote-settings.png"
alt="Image promotion settings"
caption="Image promotion settings"
max-width="40%"
%}

{:start="3"}
{:start="4"}
3. Click **Promote**.


Expand Down
2 changes: 1 addition & 1 deletion _docs/integrations/docker-registries/docker-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ The two Dockerhub accounts are `kkapelon` and `kostiscodefresh`, and Codefresh a
[Docker registries for pipeline integrations]({{site.baseurl}}/docs/integrations/docker-registries)
[Working with Docker Registries]({{site.baseurl}}/docs/ci-cd-guides/working-with-docker-registries/)
[Push step in pipelines]({{site.baseurl}}/docs/pipelines/steps/push/)
[Building and pushing an image]({{site.baseurl}}/docs/examples/example-catalog/build-and-push-an-image/)
[Building and pushing an image]({{site.baseurl}}/docs/example-catalog/ci-examples/build-and-push-an-image/)



Expand Down
2 changes: 1 addition & 1 deletion _docs/pipelines/configuration/pipeline-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Selectively restricting access to clusters for a pipeline:

{% include image.html
lightbox="true"
file="images/pipeline/pipeline-settings/pipeline-inject-cluster-accnt-setting.png"
file="/images/pipeline/pipeline-settings/pipeline-inject-cluster-accnt-setting.png"
url="/images/pipeline/pipeline-settings/pipeline-inject-cluster-accnt-setting.png"
alt="Enabling cluster contexts for injection into pipelines"
caption="Enabling cluster contexts for injection into pipelines"
Expand Down
2 changes: 1 addition & 1 deletion _docs/pipelines/post-step-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ step_name:

## Available Post-Step Operations

- [Image Metadata]({{site.baseurl}}/docs/pipelines/metadata-annotations/)
- [Image Metadata]({{site.baseurl}}/docs/pipelines/docker-image-metadata/)
- [Custom annotations]({{site.baseurl}}/docs/pipelines/annotations/)
- [Hooks in pipelines]({{site.baseurl}}/docs/pipelines/hooks/)

Expand Down
2 changes: 1 addition & 1 deletion _docs/pipelines/steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Freestyle steps are a secure replacement for `docker run` commands.
**Launch test environment** steps behave similar to compositions, but they persist after the pipeline ends. This is a great way to create preview environment from your pull requests and send to colleagues.

* [Deploy]({{site.baseurl}}/docs/pipelines/steps/deploy/)
**Deploy steps** allow you to [perform Kubernetes deployments]({{site.baseurl}}/docs/deploy-to-kubernetes/) in a declarative manner. They embody the Continuous Deployment aspect of Codefresh.
**Deploy steps** allow you to [perform Kubernetes deployments]({{site.baseurl}}/docs/quick-start/ci-quick-start/deploy-to-kubernetes/) in a declarative manner. They embody the Continuous Deployment aspect of Codefresh.

* [Approval]({{site.baseurl}}/docs/pipelines/steps/approval/)
**Approval steps** allow you to pause pipelines and wait for human intervention before resuming. They allow you to embrace the concepts of Continuous Delivery.
Expand Down
4 changes: 2 additions & 2 deletions _docs/pipelines/steps/git-clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ step_name:
- Working Directory

{{site.data.callout.callout_info}}
If you want to extend the git-clone step you can use the freestyle step. Example how to do it you can find [here]({{site.baseurl}}/docs/example-catalog/git-clone-private-repository-using-freestyle-step/).
If you want to extend the git-clone step you can use the freestyle step. Example how to do it you can find [here]({{site.baseurl}}/docs/example-catalog/ci-examples/git-clone-private-repository-using-freestyle-step/).
{{site.data.callout.end}}

## Basic clone step (project-based pipeline)
Expand Down Expand Up @@ -429,7 +429,7 @@ For more details, see the [behind the firewall page]({{site.baseurl}}/docs/insta
## Related articles
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)
[YAML steps]({{site.baseurl}}/docs/pipelines/steps/)
[Custom Git Commands]({{site.baseurl}}/docs/example-catalog/git-checkout-custom/)
[Custom Git Commands]({{site.baseurl}}/docs/example-catalog/ci-examples/git-checkout-custom/)



Expand Down
Loading