Application deployment to EKS cluster using Helm Plugin

Objective

The goal of the tutorial is to deploy Apache HTTP Server using helm chart on EKS 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 EKS Cluster

• verifying the Apache HTTP Server is successfully created on the EKS 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 EKS Cluster in a very short amount of time.

Checklist

Configure Cloud account

To connect with EKS cluster, we required to configure Cloud account, with credentials details. Configure a Cloud Account under Integration. FlexDeploy will connect to the EKS cluster and deploy the Apache HTTP Server.

1. Navigate to the Integrations

2. Select Cloud from the left-hand pane

3. Create a new Cloud account with the “+” button. Create a new Cloud account of provider type “AWS”

Open

It should have a AWS Access Key and AWS Secret Key. The user must have relevant access to do the deployment on EKS cluster.

Open

1. AWS Secret Key is a password field and hence needs to be kept hidden. To update the same click on the pencil icon as shown below

2. Update the AWS Secret Key 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 IAM user

To access the EKS cluster we need to create an AWS IAM account with required permissions.

To create the AWS IAM user access the Identity and Access Management (IAM) service page, and click on the Add users option and give the required permission to access the cluser. Once user is created, AWS secret key can be generate, this key we have to configure in cloud account.

For more information about IAM user please ref. IAM users - AWS Identity and Access Management

Assign user to relevant group so that it has relevant access to cluster

Ref: What is Amazon EKS? - Amazon EKS

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 EKS cluster. 

CLI installation

• AWS CLI should be installed in the m/c where the plugin is to be executed. Preferably add AWS CLI path in m/c classpath.

Deploy Workflows

Deploy Workflow

1. navigate to the Workflows

2. 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 EKS cluster.

Step-i: deploy the application

This step will deploy the Apache HTTP Server on the EKS 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)

Project configuration

Navigate to the Project tab and create a Project with a logical name(HelmAWS 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.

Below given are the environment-specific values which need to be updated.

Cloud Account

The AWS 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

AWS 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.

1. Navigate to the Project Configuration tab as shown above.

2. Next, select the PROPERTIES option from the left-hand pane.

3. Click on the OVERRIDE option.

4. Select the Cloud Account option from Property.

5. Select the Environment from the drop down list.

6. 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 EKS cluster by using AWS 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.