Owner: Architect:

Francesco Ilario

Story (Required)

As a Primaza Administrator or Developer,
I would like to have some tutorials in the technical documentation
so that I can easily try Primaza

Background (Required)

The Primaza Book is published at www.primaza.io and actually contains just technical information about Primaza's architecture and internals.
It is missing a Tutorials section that facilitates the on-boarding of people.

See epic for arch document link.

Glossary

See glossary in architecture document

Out of scope

NA

In Scope

• Tutorials section in The Primaza Book

Approach(Required)

The tutorials we can add here are the ones we already worked on for the demos or in tests.

Create a Tutorials sections with some tutorials on the following tutorials:

•  (Tenant Setup) How to create a Primaza Tenant, Join a cluster, and create Primaza namespaces
  • With primazactl
  • From sources with primazactl (may be joined with the one above)
  • From sources with Kustomize
• Discovery:
  • Manual Registration of a Service
  • A service published in the cluster (e.g. PSQL database)
  • An AWS RDS Service with AWS Controllers for Kubernetes (ACK)
• Claim a Service:
  • Claim with Application Name
  • Claim with Labels
  • Claim from an Application Namespace

Demo requirements(Required)

NA

Dependencies

NA

Edge Case

NA

BDD Tests

You can find BDD Test specification for this story in the "Testing Instruction" Field Tab or in the GitHub Issue linked to this story.
Click here for all BDD Tests Issues.

Acceptance Criteria

• Docs
  There is a page in our docs dedicated to Tutorials
  There is a page for each tutorial implemented
  Update architecture document with any changes while implementing
  There is a link in our main readme to the Primaza's Book Tutorials section

INVEST Checklist

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

Legend

Unknown
Verified
Unsatisfied