| Table of Contents |
|---|
Objective
The goal of the this tutorial is to deploy an Apache HTTP Server using helm chart on EKS Cluster through FlexDeploy Helm pluginHelm Chart on an Amazon Elastic Kubernetes Service (Amazon EKS) cluster through FlexDeploy using the Helm Plugin. For this tutorial, we shall will be doing setting up an automated deployment of the an Apache HTTP Server , using the helm chart Helm Chart which is present at in this chart repository (https://charts.bitnami.com/bitnami) . The steps will include:
configuration of the Configuring properties e.g. config file path, Cloud cloud account, and CLI path .
deploying Deploying the Apache HTTP Server to an EKS Clustercluster
verifying Verifying the Apache HTTP Server application 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 cluster in a very short amount of time.
Checklist
Checklist | Description |
AWS Access Key | AWS Access Key of the user. |
AWS Secret Key | Password for the Access Key |
AWS Default Region | Default region can be set. eg. ap-south-1 |
AWS CLI installation | AWS CLI needs to be installed where the plugin operation shall run (FlexDeploy server) |
AWS CLI in class path | AWS CLI should be added to class path on the FlexDeploy Server. Else the path can also be set under FlexDeploy environment level property |
EKS Setup | EKS cluster should be created in AWS and a kubeconfig file should be present with the context of the cluster. |
Configure Cloud
...
Account
To connect with EKS cluster, we required to configure Cloud cloud account, with credentials details. Configure a Cloud Account under Integration. FlexDeploy will connect to the EKS cluster and deploy the Apache HTTP Server.
Navigate to the Integrations
Select Cloud from the left-hand pane
Create a new Cloud account with the “+ ” Create button. Create a new Cloud account of provider type “AWS”
...
AWS Secret Key is a password field and hence needs to be kept hidden. To update the same it, click on the pencil icon as shown below
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.
...
...
Prerequisites
Configure IAM
...
User
To access the EKS cluster we need to create an AWS IAM account with required permissions.
...
Assign user to relevant group so that it has relevant access to cluster
kubectl edit -n kube-system configmap/aws-auth
...
Ref: https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html
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
...
Navigate to
...
Workflows and create a
...
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 workflow using the 
button as highlighted below.
...
Below is a sample deploy workflow to deploy the application on the an EKS cluster.
...
Step-i: deploy the application
...
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 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(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.
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 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.
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.
...