Skip to content

Latest commit

 

History

History
192 lines (122 loc) · 9.94 KB

control-plane.md

File metadata and controls

192 lines (122 loc) · 9.94 KB
Raw

Starting from the 0.2.0 version Pipeline supports managed Kubernetes clusters on Azure AKS as well.

Getting Started

The Pipeline Control Plane takes care of creating a Kubernetes cluster on the desired cloud provider and can be hosted on both AWS and Azure.

Prerequisites of hosting the control plane on AWS

Hosting Pipeline Control Plane and creating Kubernetes clusters on AWS

  1. AWS account
  2. AWS EC2 key pair

Prerequisites of hosting the control plane on Azure

Hosting Pipeline Control Plane and creating Kubernetes clusters on Azure

  1. Azure subscription with AKS service enabled.
  2. Obtain a Client Id, Client Secret and Tenant Id for a Microsoft Azure Active Directory. These information can be retrieved from the portal, but the easiest and fastest way is to use the Azure CLI tool.
$ curl -L https://aka.ms/InstallAzureCli | bash
$ exec -l $SHELL
$ az login

You should get something like:

{

  "appId": "1234567-1234-1234-1234-1234567890ab",
  "displayName": "azure-cli-2017-08-18-19-25-59",
  "name": "http://azure-cli-2017-08-18-19-25-59",
  "password": "1234567-1234-1234-be18-1234567890ab",
  "tenant": "7654321-1234-1234-ee18-9876543210ab"
}
  • appId is the Azure Client Id
  • password is the Azure Client Secret
  • tenant is the Azure Tenant Id

In order to get Azure Subscription Id run:

az account show --query id

Launch Pipeline Control Plane on AWS

The easiest way for running a Pipeline Control Plane is to use a Cloudformation template.

  • Navigate to: https://eu-west-1.console.aws.amazon.com/cloudformation/home?region=eu-west-1#/stacks/new

  • Select Specify an Amazon S3 template URL and add the URL to our template https://s3-eu-west-1.amazonaws.com/cf-templates-grr4ysncvcdl-eu-west-1/2018026em9-new.templatee93ate9mob7

  • Fill in the following fields on the form:

    • Stack name

      • specify a name for the Control Plane deployment

    • AWS Credentials

    • Azure Credentials and Information - needed only for creating Kubernetes clusters on Azure

      • AzureClientId - see how to get Azure Client Id above
      • AzureClientSecret - see how to get Azure Client Secret above
      • AzureSubscriptionId - your Azure Subscription Id
      • AzureTenantId - see how to get Azure Client Tenant Id above

    • Control Plane Instance Config

      • InstanceName - name of the EC2 instance that will host the Control Plane
      • ImageId - pick the image id from the README
      • KeyName - specify your AWS EC2 key pair

    • Banzai Pipeline Credentials

      • Pipeline API Password - specify the password for accessing the Pipeline REST API exposed by the Pipeline PaaS. Take note of the user name and password as those will be required when setting the secrets for the GitHub repositories in the CI/CD workflow.

    • Banzai-Ci Credentials

      • Orgs - comma-separated list of Github organizations whose members to grant access to use Banzai Cloud Pipeline's CI/CD workflow
      • Github Client - GitHub OAuth Client Id
      • Github Secret - Github OAuth Client Secret

    • Grafana Dashboard

      • Grafana Dashboard Password - specify password for accessing Grafana dashboard with defaults specific to the application

    • Prometheus Dashboard

      • Prometheus Password - specify password for accessing Prometheus that collects cluster metrics

    • Advanced Pipeline Options

      • PipelineImageTag - specify 0.2.0 for using current stable Pipeline release.

    • Slack Credentials

      • this section is optional. Complete this section to receive cluster related alerts through a Slack push notification channel.

    • Alert SMTP Credentials

      • this section is optional. Fill this section to receive cluster related alerts through email.

  • Finish the wizard to create a Control Plane instance.

  • Take note of the PublicIP of the created Stack. We refer to this as the PublicIP of Control Plane.

  • Go back to the earlier created GitHub OAuth application and modify it. Set the Authorization callback URL field to http://{control_plane_public_ip}/authorize

Launch Pipeline Control Plane on Azure

The easiest way for running a Pipeline Control Plane is deploying it using an ARM template.

  • Navigate to: https://portal.azure.com/#create/Microsoft.Template

  • Click Build your own template in editor and copy-paste the content of ARM template into the editor then click Save


    • Resource group - We recommend creating a new Resource Group for the deployment as later will be easier to clean up all the resources created by the deployment

    • Specify SSH Public Key

    • SMTP Server Address/User/Password/From

      • these are optional. Fill this section to receive cluster related alerts through email.

    • Slack Webhook Url/Channel

      • this section is optional. Complete this section to receive cluster related alerts through a Slack push notification channel.

    • Banzai Pipeline Credentials

      • Pipeline Password - specify the password for accessing the Pipeline REST API exposed by the Pipeline PaaS. Take note of the user name and password as those will be required when setting the secrets for the GitHub repositories in the CI/CD workflow.

    • Prometheus Dashboard

      • Prometheus Password - specify password for accessing Prometheus that collects cluster metrics

    • Grafana Dashboard

      • Grafana Dashboard Password - specify password for accessing Grafana dashboard with defaults specific to the application

    • Banzai-Ci Credentials

      • Orgs - comma-separated list of Github organizations whose members to grant access to use Banzai Cloud Pipeline's CI/CD workflow
      • Github Client - GitHub OAuth Client Id
      • Github Secret - Github OAuth Client Secret

    • Azure Credentials and Information

      • Azure Client Id - see how to get Azure Client Id above
      • Azure Client Secret - see how to get Azure Client Secret above
      • Azure Subscription Id - your Azure Subscription Id
      • Azure Tenant Id - see how to get Azure Tenant Id above

    • Finish the wizard to create a Control Plane instance.

    • Open the Resource Group that was specified for the deployment

    • Take note of the PublicIP of the deployed Control Plane.