Skip to content

Improve DSS operations documentation #1715

Description

@BenjaminPelletier

Is your feature request related to a problem? Please describe.
During #1677, some issues were identified with the DSS operations documentation that were beyond the scope of the PR. This Issue serves to capture them to be addressed after #1677 is merged.

Describe the solution you'd like
Resolve the issues identified below:

Resolve the issues previously noted in TODO.txt:

  • Ensure deployment/pooling instructions are accurate, especially regarding the expected working directory when calling make_certs.py
  • When linking to the repository, ensure repo version matches documentation version (e.g., 0.22.0 tag)
  • Ensure VAR_* references outside the manual deployment instructions are defined for the terraform approach or harmonized
  • In Minikube documentation, replace dss-local-cluster with ${cluster_name} or similar and have users export/set that once initially
  • Ensure Minikube documentation describes how to accomplish pooling
  • Actually identify which tools are needed in operations/index.md rather than "some of these tools" -- the purpose of this statement is procedural to ensure ops personnel have the right tools installed, so we should identify which tools those are rather than having them guess or figure it out themselves
  • Add/migrate helm documentation if that will be an officially-supported way to deploy services

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Normal prioritydocumentationdssRelating to one of the DSS implementations

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions