The following is a guide for how to create an environment that contains the elements described in Compare and contrast.

To create a cluster, using the declarative approach

  1. Create a declaration and edit it to suit your needs
  2. Apply the declaration

Commands

To scaffold a cluster declaration, run the following:

# Usage
okctl scaffold cluster > PATH

# Example
okctl scaffold cluster > cluster.yaml


# Usage
okctl scaffold cluster > PATH

# Example
okctl scaffold cluster > cluster.yaml

To create a cluster based on the declaration, run the following:

# Usage
okctl apply cluster -f PATH

# Example
okctl apply cluster -f cluster.yaml

Usage

When running ...

okctl scaffold cluster > cluster.yaml

... you'll end up with a file beginning with this:

apiVersion: okctl.io/v1alpha1
kind: Cluster

## For help finding values, see https://okctl.io/getting-started/create-cluster
metadata:
  ## Account ID is your AWS account ID
  accountID: '123456789012'
  .......

Need more details? Check out Cluster reference.

Modify the declaration to suit your situation and needs, then use ...

okctl apply cluster -f cluster.yaml

... to have Okctl generate a cluster based on the declaration.

That's it

Sit back and enjoy or go do something else while Okctl does its thing (can take up to an hour).