link_cli:"https://cli.codefresh.io"

link_git_examples:"https://github.com/codefresh-examples/examples/"

link_api:"https://g.codefresh.io/api/"

link_plugins:"https://github.com/codefresh-io/plugins"

link_plugins:"https://github.com/codefresh-io/plugins/blob/master/CATALOG.md"

ga_tracking_code:"UA-112283329-1"

localurl:/docs/new-helm/integration-tests-with-helm/

-title:Best Practices

localurl:/docs/new-helm/best-practices/

-title:Codefresh plugins

icon:https://codefresh.io/wp-content/uploads/2018/01/plugins.png

url:''

links:

-title:Plugins

localurl:/docs/codefresh-plugins/plugins/

-title:Contribute Codefresh Plugin

localurl:/docs/codefresh-plugins/contribute-codefresh-plugin/

-title:"Codefresh CLI"

new:true

icon:https://codefresh.io/wp-content/uploads/2018/01/cli.png

-title:Deployment to Kubernetes

url:"/deployment-to-kubernetes-quick-start-guide"

-title:Codefresh Plugins

pages:

-title:Plugins

-title:Contribute Codefresh Plugin

-title:Whats new?

url:"/whats-new"

pages:

-title:"YAML Examples"

url:"/yaml-examples"

pages:

-title:"Custom YAML steps"

url:"/ready-to-use-yaml-steps"

-title:Examples

url:"/examples"

sub-pages:

-title:Python

url:"/python"

sub-pages:

-title:Djanga

url:"/djanga"

-title:Django

url:"/django"

-title:Voting app

url:"/voting-app"

-title:Java

-title:Git providers

url:"/git-providers"

sub-pages:

-title:Integration with self-hosted (on-prem) git providers

url:"/integrating-codefresh-with-on-premises-git-providers"

-title:Activate integration with your self hosted Git server

url:"/activate-integration-with-your-self-hosted-git-server"

-title:Configure a Bitbucket Server Webhook

url:"/disabling-codefresh-caching-mechanisms"

-title:Handling commit messages with a quote character

url:"/handling-commit-messages-with-quotes"

-title:The terminating the workflow by system

url:"/the-terminating-the-workflow-by-system"

-title:Workflow terminated by the system

url:"/workflow-terminated-by-system"

-title:The docker image does not exist or no pull access

url:"/the-docker-image-does-not-exist-or-no-pull-access"

-title:'Build step: No such file or directory'

toc:true

Clones a Git repository to the filesystem.

<divclass="bd-callout bd-callout-warning"markdown="1">

This step is not required and is added automatically for the main repository.

</div>

{% highlight yaml %}

{{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/yaml-examples/examples/git-clone-private-repository-using-freestyle-step/)

{{site.data.callout.end}}

A git clone step is transparently added to git attached pipelines without you having to explicitly add a step into the pipeline. This is a convenience to enable easy CI pipelines.

If you do not require git cloning, or you would like to customize the implicit git cloning behaviour, you can choose to skip the automatically added git clone step.

There are 2 ways to do that:

1. Add a pipeline environment variable called`CF_SKIP_MAIN_CLONE` with value of`true`.

-or-

2. Add a step with key`main_clone` to your pipeline. This step can be of any type and can do any action. This step will override the default clone implementation. for example:

steps:

main_clone:

image:alpine/git:latest

commands:

-git clone ...

another_step:

| -------------------------------------------------| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| {% raw %}`${{CF_REPO_OWNER}}`{% endraw %}| Repository owner.|

| {% raw %}`${{CF_REPO_NAME}}`{% endraw %}| Repository name.|

| {% raw %}`${{CF_BRANCH}}`{% endraw %}| Branch name of the Git repository of the main pipeline, at the time of execution. <br/>You can also use {% raw %}`${{CF_BRANCH_TAG_NORMALIZED}}`{% endraw %} to get the branch name normalized. It will be without any chars that are illegal in case the branch name were to be used as the Docker image tag name.|

| {% raw %}`${{CF_BRANCH}}`{% endraw %}| Branch name (or Tag depending on the payload json) of the Git repository of the main pipeline, at the time of execution. <br/>You can also use {% raw %}`${{CF_BRANCH_TAG_NORMALIZED}}`{% endraw %} to get the branch name normalized. It will be without any chars that are illegal in case the branch name were to be used as the Docker image tag name.|

| {% raw %}`${{CF_BASE_BRANCH}}`{% endraw %} | The base branch used during creation of Tag

| {% raw %}`${{CF_COMMIT_AUTHOR}}`{% endraw %}| Commit author.|

| {% raw %}`${{CF_COMMIT_URL}}`{% endraw %}| Commit url.|

| {% raw %}`${{CF_COMMIT_MESSAGE}}`{% endraw %}| Commit message of the git repository revision, at the time of execution.<br/> The messages quotes are escaped (i.e. ' is not\', " is now\").|

group:codefresh-yaml

redirect_from:

-/docs/codefresh-yaml/

-/docs/what-is-the-codefresh-yaml

-/docs/what-is-the-codefresh-yaml/

toc:true

Quick example:

description:""

group:configure-ci-cd-pipeline

toc:true

redirect_from:

-/docs/build-status

-/docs/build-status/

description:""

group:deploy-to-kubernetes

permalink:/:collection/deploy-to-kubernetes/adding-non-gke-kubernetes-cluster/

redirect_from:

-/docs/adding-non-gke-kubernetes-cluster

-/docs/adding-non-gke-kubernetes-cluster/

toc:true

max-width="40%"

%}

The integration between Codefresh and your Kubernetes cluster is API based and relies on a Kubernetes service account of your choosing that will be used to manage the integration.

The configurations you'll be required to add are:

The integration between Codefresh and your Kubernetes cluster is API based and relies on a Kubernetes service account of your choosing that will be used to manage the integration.

The configurations you'll be required to add are:

{:start="1"}

1. Name - Any name of your choosing, that will represent your cluster context in Codefresh.

1. Name - Any name of your choosing, that will represent your cluster context in Codefresh.

{:start="2"}

2. Host - The endpoint for your Kubernetes API

{:start="3"}

3. Certificate - The Kubernetes service account certificate used for the integration with Codefresh

{:start="4"}

4. Token - The Kubernetes service account token used for the integration with Codefresh

{% include image.html

-[Deployment to Kubernetes - Quick start guide]({{ site.baseurl }}/docs/deploy-to-kubernetes/deployment-to-kubernetes-quick-start-guide/)

-[Example - Deploy demochat to Kubernetes cluster]({{ site.baseurl }}/docs/deploy-to-kubernetes/codefresh-kubernetes-integration-demochat-example/)

After adding your cluster configurations and in case the test fails, click "Save" to get the error message back.

%}

{:.text-secondary}

{% highlight shell %}