Objective
The goal of the tutorial is to deploy Apache HTTP Server using helm chart on GKE Cluster through FlexDeploy Helm plugin. For this tutorial we shall be doing automated deployment of the Apache HTTP Server, using the helm chart which is present at chart repository (https://charts.bitnami.com/bitnami) . The steps will include:
configuration of the properties e.g. config file path, Cloud account, and CLI path.
deploying the Apache HTTP Server to GKE Cluster
verifying the application is successfully created on the GKE cluster.
We will walk through each of the FlexDeploy features that will be created/configured to accomplish this goal and have the Apache HTTP Server deployed on the GKE Cluster in a very short amount of time.
Checklist
Checklist | Description |
GCP Project Id | Project Id to connect to desired GCP project. |
GCP Key File | The GCP Key File to connect GKE cluster. |
GCP CLI installation | GCP CLI needs to be installed where the plugin operation shall run (FlexDeploy server) |
GCP CLI in class path | GCP CLI should be added to class path on the FlexDeploy Server. Else the path can also be set under FlexDeploy environment level property |
GKE Setup | GKE cluster should be created in GCP and a kubeconfig file should be present with the context of the cluster. |
Configure Cloud account
To connect with GKE cluster, we required to configure Cloud account, with credentials details. Configure GCP Cloud Account under Integration. FlexDeploy will connect to the GKE cluster and deploy the Apache HTTP Server.
Navigate to the Integrations
Select Cloud from the left-hand pane
Create a new Containers account with the “+” button. Create a new Cloud account of provider type “GCP”
It should have a Project Id and Key File configured in it. The user must have relevant access to do the deployment on GKE cluster.
Key File is a password field and hence needs to be kept hidden. To update the same click on the pencil icon as shown below
Please refer to create the service account key file. Configure-service-account
2. Update the entire Key File value under Secret Text. This is to make sure no one else can retrieve the password
After configuration we can use the Cloud Account.
Pre-requisite
Configure service account
To access the GKE cluster we need to create a service account.
Creating a service account to connect with the GKE cluster. Adding Kubernetes Engine Developer role for this tutorial. Different roles are available with different access(which can be assigned).
Next we have to create a Service Account Key file which will verify the identity of the Service Account during execution. For more information about key file: https://cloud.google.com/iam/docs/creating-managing-service-account-keys , this key file we have to configured in GCP Cloud account.
Created key file should have the following format, where PRIVATE_KEY is the private portion of the public/private key pair:
e.g of the Key File -
The entire content of the key file we have to configured in GCP Cloud account as secret text.
Configure kubeconfig file
A Kubeconfig is a YAML file with the details to connect to Kubernetes Cluster using certificate/secret tokens to authenticate the cluster. This is essential for Helm Plugin to connect to target GKE cluster.
CLI installation
GCP CLI should be installed in the m/c where the plugin is to be executed. Preferably add GCP CLI path in m/c classpath. Please ref. https://cloud.google.com/sdk/docs/install for more information about installation.
Deploy Workflows
Deploy Workflow
navigate to the Workflows
Select the “+” button from the left-hand pane to create a new workflow
The Workflow Group and Subgroup define the folder hierarchy. Once both workflows are created it should look like the below. No constraint on workflow or folder naming convention.
The steps of the workflow execution can be configured through the Workflow Definition section.
Below given is a sample deploy workflow to deploy application on the GKE cluster.
Step-i: deploy the application
This step will deploy the Apache HTTP Server on the GKE cluster, using the helm chart which is present at chart repository (https://charts.bitnami.com/bitnami) . Context must be provided to apply changes. The context should be present inside kubeconfig file.
In above configuration using following Inputs, for all input and their description please ref. deploy (Helm)
Input Name | Input Value | Description |
|---|---|---|
Chart Name | apache | Name of a chart to be installed. (Reference/Package/Directory/URL). If empty takes the chart name from the project configuration. |
K8s Context | k8s-test-cluster | K8s Context where the chart will be installed |
Release Name | test-helm-new | Release name. If empty takes the chart name from the project configuration. If unspecified, it will autogenerate one for you |
Repository Name | Name of a chart repository | |
Config file | /home/oracle/.kube/azure/config | K8s config file |
Project configuration
Navigate to the Project tab and create a Project with a logical name(Helm in this case)
Configure the Deploy workflow that has been created in previous steps as shown below.
Target Properties
Select Topology from the menu and then select Targets from menu. Select the target group and environment, provide the properties detail, according to the description.
Properties | Mandatory field | Description |
Cloud Account | Optional | Select the Cloud Account to connect cluster. |
CLI Path | Optional | Directory where Cloud CLI is installed. |
Kubeconfig File Path | Optional | Absolute path of kubeconfig file |
Below given are the environment-specific values which need to be updated.
Cloud Account
The GCP Cloud account needs to be set here from the drop-down. It will show all Cloud Accounts configured under Topology, which we have already mentioned earlier.
Kubeconfig file path
Absolute path of config file can be set as environment property, if path is not set then by default plugin look for config file in user directory.
CLI path
GCP CLI path can be set as environment property, if it’s not set then by default plugin use classpath.
Override properties at Project level
Let assume a scenario, where we want to change Cloud account for any specific project. Apart from setting at environment level, it can also be set at project properties by using Override Property. Please check below mentioned steps.
Navigate to the Project Configuration tab as shown above.
Next, select the PROPERTIES option from the left-hand pane.
Click on the OVERRIDE option.
Select the Cloud Account option from Property.
Select the Environment from the drop down list.
Select the Target Group from the drop down list.
Build Execution
For detailed steps on how to initiate deploy operation using Helm plugin, please refer to Deploy through FlexDeploy using Helm plugin
Post deployment
Post deployment success from plugin it can take a little while for the deployment and running.
Once deployment successfully completed, we can see the related details on GKE cluster by using GCP console.
Congratulations! You have successfully completed the Apache HTTP Server deployment.
Now that you have configured FlexDeploy for deployment operation using Helm plugin, it is extremely easy to replicate the same for other Cloud Provider. Simply use the Copy Project feature and a new project will be created with all of the configuration completed already. You just need to make the necessary configuration changes.