Quick start - Linux
Last updated
Last updated
latest kubectl command-line tool:
latest helm command-line tool:
latest aws-cli command-line tool. Make sure to install v2 of the aws-cli and not v1:
An aws account you control:
Download the notops CLI from and rename it to notops. Or use the following command:
Once you have an AWS account ready to go, you'd need an with enough permissions to run notops. These permissions allow notops to create and manage the infrastructure for you.
You can skip this step and use the built-in AdministratorAccess policy instead. See IAM policy for the CLI for more details.
Enter notops-runner as the user name
Disable console access for this user by keeping the checkbox for Provide user access to the AWS Management Console - optional unchecked.
Click Next. Select the option to Attach policies directly
Attach the policy you created in the previous step, or the built-in AdministratorAccess policy.
Click Next
Click Create user
Once the user has been created,
Select Users from the navigation bar on the left
Click on the notops-runner user
Go to the Security credentials tab
Scroll down and under the Under Access keys, choose Create access key
On the Access key best practices & alternatives page, pick Application running outside AWS and click Next
Optionally set a description and then click Create access key
On the Retrieve access keys page, copy both the Access key and the Secret access key (or click on the Download .csv file). This is your only opportunity to save your secret access key. If you don't save the secret key now, you cannot retrieve it again. Keep the secret key in a safe place.
We'll use the access key and the secret access key during the subsequent steps.
Create a local file named notops-config.yaml with the following contents. Replace demo.notops.io with a test-domain you want to access publicly over HTTPS.
To understand all the configuration options, please check Configuration.
Open your favorite terminal, and set the following env-vars
In the existing terminal where you specified your AWS credentials, run the following command:
This will take some time, so grab a coffee and scroll the internets for about 20 to 30 minutes.
Once the CLI finishes running, you'd have a whole environment ready to go. Here are the follow up steps you'd take:
Unless you specified otherwise, notops would manage the DNS for your domain using a public Route53 Zone. You'd need to set up the nameserveres for this zone. Follow these instructions: Configure Domain Nameservers.
If you used the sample config provided above, you can skip this step. Otherwise, please follow Verify SSL Certificate to make sure your SSL cert has been verified.
Now, you're ready to start deploying on Kubernetes. Run the following command to see all the pods running in the kube-system namespace.
You can use the cluster anyway you like.
To create a custom policy, follow to use the JSON policy editor, and provide the permissions outlined in . Name this policy notops-runner. You'd replace the entire content of the JSON editor with the policy from the content from .
Follow to create a new IAM user named notops-runner. When creating the user, keep the following in mind:
Go to the
You'd need to command-line tool.
The following command will set up your . Replace <cluster-name> below with the value of the environmentName config, and <region> with the value of aws.region from the config file.