Skip to content

Initial Setup Wizard

Initial Setup

Whether you installed ESH in your own AWS account or are using the SaaS platform, initial setup is the same, just follow the wizard to setup the core building components of an ESH installation.

As the initial user you will be logged on as an organization admin, this means you have complete control and can create resources in, and manage your entire organization. ESH takes you through a setup wizard that will familiarize you with the basic concepts. Resources such as Tenant, Template and Deployment created in this initial setup will typically be deleted before moving onto the organization setup guide.

On completion of the setup wizard you will have created:

  • Tenant - A tenant is the owner of deployments, tenants are granted access to Targets and Templates, and users are granted access to the tenants they need.

  • Template - A template defines the resources that will be part of a deployment. You will need a Git repository with some Terraform code in that is appropriate to the target you wish to deploy to. There are 3 sample templates in the ESH public repository to help you get started, they are:

    • An AWS S3 Bucket (https://github.com/Enterprise-Self-Service/template-sample-aws-s3)
    • An Azure Storage Account (https://github.com/Enterprise-Self-Service/template-sample-azure-storage-account)
    • A GCP Cloud Storage Bucket (https://github.com/Enterprise-Self-Service/template-sample-gcp-storage-bucket)

    Choose an appropriate template depending on where you wish to make your first deployment

  • Target - A Target defines the type, the account/ subscription/ project and the authentication details for that target

  • Deployment - A Deployment deploys the chosen template to the chosen target, if you chose one of the above templates, you will have a place to store objects in the cloud of your selection.

Step 1 - Create a Tenant

Choose a tenant name, and regions you wish the tenant to be able to deploy to.

Initial Tenant Setup

Step 2 - Create a Target

Enter the details for your target, here we chose AWS and used the ESH default role as described in Installation documentation.

Initial Target Setup

Step 3 - Create a Template

For initial setup choose one of our public templates, they are setup with version tags already and so will help familiarize you with the basics and get you started with your first deployment very quickly. As they are public, do not type an auth token to access the repo.

Initial Template Setup

Step 4 - Download a Template Version

For a Template to be usable in ESH, it has to be tagged so versions can be enabled. This step will download a tag, ESH will scan the template tag for variables for deployment form and enable it for use in deployments. Click the load version button for the version you wish to be able to use. This is typically the latest version.

Download Template Version

Step 5 - Create a Deployment

Fill in the New Deployment form by specifying a unique name for the Deployment, selecting Target and Template, then fill in the values for the variables for the Template you chose.

Create First Deployment

Acknowledge that you wish to create the Deployment

Deployment Acknowledge

You created a deployment and now it is deloying to your target

Your Deployment is Running

And now you have an AWS S3 bucket deployed in eu-west-1 region.

Deployment Success - It's Deployed

What's Next

Now that you have the key concepts, the next step is to model your organizations structure and teams in ESH. Learn how to do this here

In addition, you can learn more about templates here, targets here and user management here.