Skip to content

Latest commit

 

History

History
144 lines (95 loc) · 2.82 KB

README.md

File metadata and controls

144 lines (95 loc) · 2.82 KB

GOV.UK EKS helpers

Shell scripts to help with doing things in GOV.UK's EKS infrastructure.

Installation

  1. If you haven't connected to EKS before, set up the tools required to use the GOV.UK Kubernetes platform.

  2. Clone this repo locally.

    $ cd ~/govuk
$ git clone git@github.com:ollietreend/govuk-eks-helpers.git

  3. (optional) Add ~/govuk/govuk-eks-helpers/bin to your PATH, so you can call the scripts from anywhere.

    Assuming you use ZSH:

    $ echo "export PATH=\$PATH:\$HOME/govuk/govuk-eks-helpers/bin" >> ~/.zshrc

    For this change to take effect, you'll need to open a new Terminal tab, or run:

    $ source ~/.zshrc

Usage

Open a Rails console

$ eks-console {environment} {app-name}
Example

Open a Rails consosle on Whitehall in integration:

$ eks-console integration whitehall-admin

Run a Rake task

$ eks-rake {environment} {app-name} {rake-task}
Example

Run a reslugging Rake task on Whitehall in integration:

$ eks-rake integration whitehall-admin reslug:person[old-slug,new-slug]

Get a list of available Rake tasks:

$ eks-rake integration whitehall-admin -T

Open a bash shell

$ eks-bash {environment} {app-name}

Use this command to open a bash shell on the container (effectively recreating an SSH experience).

Example

Open a bash shell on Whitehall in integration:

$ eks-bash integration whitehall-admin

Connect to a running container

$ eks-connect {environment} {app-name} {command}

Use this to run any other command on the container.

Example

Run ls on Whitehall in integration:

$ eks-connect integration whitehall-admin ls

Commands that contain spaces need to be wrapped in quote marks. For example:

$ eks-connect integration whitehall-admin "ls -lh"

Recognised environments

There are three GOV.UK EKS environments: integration, staging and production.

These scripts also recognise 'short hand' versions of the environments – where they'll match, so long as it partially matches the beginning of a valid environment.

For example, you can connect to integration by simply using the letter i:

$ eks-console i whitehall-admin

Which is functionally the same as:

$ eks-console integration whitehall-admin