Owner: Architect:

Francesco Ilario

Story (Required)

As a Primaza Administrator, I would like to have completions for primazactl so that it's easier to use primazactl.

Background (Required)

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

See epic for arch document link.

Glossary

See glossary in architecture document

Out of scope

NA

In Scope

• bash shell completions
• zsh shell completions

Approach(Required)

Introduce a library to auto-generate completions for target shells.
An examples for Go is cobra or Argcomplete for python.

The primazactl completion command should require a s|-shell argument.

Demo requirements(Required)

A great demo will show working completion in bash and zsh shells.

Dependencies

• primazactl

Edge Case

NA

BDD Tests

NA

Acceptance Criteria

• Development
  primazactl has a completion command that prints out completions for a given shell

• QE

• Docs
  There is a section in primazactl docs dedicated to explaining how to generate and source completions

INVEST Checklist

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

Legend

Unknown
Verified
Unsatisfied