Learn how to run Codefresh pipelines inside your GKE cluster
Codefresh has partnered with Google Cloud and allows you to install a Codefresh pipeline builder inside your own Kubernetes cluster. The integration is available in the Google Marketplace for Kubernetes apps at https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh
Once you configure Codefresh to use your own Kubernetes cluster for builds you will enjoy all benefits of a Hybrid installation as the Codefresh UI and management dashboards will still run in a SAAS manner, while the actual builds and pipelines will execute in your own cluster.
The major benefits are the following:
- You define exactly what resources are used for your builds instead of relying on Codefresh infrastructure.
- The management UI is still running on the Codefresh premises and is managed by the Codefresh team allowing you to focus on your builds.
- The Codefresh builder can have access to all private resources that run in your cluster so it is very easy to use resources that should not be exposed to the Internet for any reason.
- Unified billing. You pay a single bill to Google that includes the price for your Kubernetes cluster as well as the Codefresh pipelines.
To start the integration, you need the following:
- A Google Cloud account with billing enabled
- A GKE cluster that will run all builds and pipelines
- A Codefresh account (creating an account is free, you pay only for builds)
Then visit the Codefresh GKE page at https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh
Using Codefresh from the Google Marketplace
When you configure Codefresh integration from the Google Marketplace a special Codefresh runner is installed in your own cluster.
The Codefresh UI is still hosted by Codefresh in a SAAS manner. The builds themselves however run inside your own cluster.
The builder is responsible for executing all your builds and notifying the Codefresh GUI for their status. You can also access internal cluster resources that are normally not accessible to the SAAS hosted Codefresh builders.
You can still run builds in the Codefresh SAAS infrastructure if you wish, and therefore both approaches are valid at the same time.
Usage and Billing
To start using the service you need to enable billing in your Google Cloud account. Once that is done, Codefresh billing is integrated into your Google invoices.
You will pay for the cluster resources to Google, plus the Codefresh builds. Codefresh does not collect any payment from you directly. Google Cloud will invoice you for both the cluster infrastructure and the cluster usage.
Current pricing for Codefresh builds is always shown in the marketplace page.
Step 0 - Create a Codefresh API key
To start the installation process log into your Codefresh account and visit the API Keys area by selecting User Settings from the left sidebar and then scrolling down to the API Keys section.
Then click the Generate button to create a new API KEY.
You can give your token any name you wish so that you can remember its purpose. The token is tied to your Codefresh account and should be considered sensitive information. Give access to all scopes (i.e. check all boxes). After you copy the token there is no way to get it back. Copy it into your clipboard before closing the dialog.
With the token at hand we can go to the Google marketplace.
Step 1 - Install the Codefresh application in your Google Cloud cluster
Navigate to https://console.cloud.google.com/marketplace/details/codefresh-gke/codefresh and select a Google project that has billing enabled from the drop-down menu at the top of the page.
Then click the Configure button:
On the next screen you define the general settings for the installation. These include:
- The cluster that will be used for installation
- An existing or new namespace where the Codefresh builder will reside
- A name for your installation (arbitrary choice)
- Your Codefresh API token that you created in the previous section
- The selection of the account that will be used for the cluster management.
Make sure that you note down the namespace you used, at it becomes important later on inside the Codefresh UI. Once you set everything click the Deploy button and wait some minutes for the installation to take place.
The Codefresh application is now installed on your cluster.
Step 2 - Setup communication with Codefresh SAAS
To finish the installation, we need to make Codefresh SAAS aware of the new builder.
On the right hand-side, a full command is shown that completes the installation.
This command must be executed from a shell that has
kubectl installed with the correct configuration for the cluster that was used for the installation. If you already have a local shell
that points to your cluster, feel free to paste the command there and run it.
The easiest way to run it in any other case is via the Google shell. Click the Activate Google shell icon from the top right and wait a bit until the shell appears at the bottom part of the window.
First you need to setup
kubectl access. Run:
This will show you a list of your clusters. Find the one that has the Codefresh application and run:
This will setup
kubectl access. You can try running some command such as
kubectl get nodes and
kubectl cluster-info to verify that cluster communication is setup correctly.
Then run the full command. Here is an example:
Once the command is finished you can visit the Codefresh Kubernetes dashboard and you will see your Google Cloud cluster already configured.
The full integration is now ready, and you can start running Codefresh pipelines in your own cluster.
Step 3 - Start running pipelines
Now whenever you setup a Codefresh pipeline you can choose its execution environment and point it to your own cluster with the Codefresh builder.
At this point if you have a Codefresh browser window open, make sure that you logout and then login again so that the new UI options regarding your cluster become available.
Open any Codefresh pipeline and toggle the Run on Environment switch. Select the cluster and the namespace that you used for the installation in step 1.
You can still use the Codefresh SAAS if you don’t enable this switch. You can choose which pipelines run in Codefresh SAAS and which use your cluster depending on your needs.
Alternative installation from the command line
This guide explains the graphical installation via the Google Cloud console. You can also install the Codefresh application using command line procedures.
For this installation mode see the manual installation guide.
Removing the installation.
If you want to remove the Codefresh builder from your cluster, navigate to the “Applications” page in the Google Cloud console and click the delete button.
You can install again the Codefresh builder from the marketplace.