Owner: Architect:

Francesco Ilario

Story (Required)

As a Primaza Administrator, I would like to have a command line tool so that I can setup Primaza clusters easily.

Background (Required)

As described in Primaza's architecture document, we need to define a simple Command Line Application for Primaza Administrator.
The tool will help Primaza Administrators installing Primaza on a cluster and configuring Worker clusters.

See epic for architecture document link.

Glossary

See glossary in architecture document

Out of scope

• Add commands for configuring a cluster as Worker cluster
• ClusterEnvironment's creation
• Clusters creation: assume clusters are up and running

In Scope

• Scaffold application
• Command for installing Primaza on a cluster

Approach(Required)

primazactl should be able to configure a Primaza Cluster.

Primaza Cluster configuration means installing Primaza Operator into the target cluster and creating a RSA Key >= 2048 for configuring access to Worker clusters.
Primaza installation can rely on Operator SDK.

Most of the logic is already implemented in our BDD tests (in Python), suggested approach is to leverage on that code to implement primazactl.
In designing the commands provided by primazactl, Git's idea of "plumbing" and "porcelain" commands may inspire you.

Demo requirements(Required)

A great demo would install Primaza on a given cluster using primazactl.

Dependencies

NA

Edge Case

NA

Acceptance Criteria

• Development
  primazactl code is published in its repository primaza/primazactl
  primazactl can configure Primaza Clusters.
  primazactl has an help command or parameter for each commands and subcommands.
  primazactl has an help command that explains how it works.

• QE
  There are test cases for Primaza Clusters configuration.

• Docs
  There is a page in our docs dedicated to explaining what primazactl is and how it works
  There is a section in the primazactl docs (bullet above) dedicated to explaining how to use primazactl to configure a Primaza cluster
  Update architecture document with any changes while implementing primazactl
  There is a link in our main readme to the primazactl page

INVEST Checklist

Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated

Legend

Unknown
Verified
Unsatisfied