Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a user I want to learn whether and how documentation enables me to deploy the service(s) #1

Open
12 tasks
sgort opened this issue Jan 28, 2021 · 1 comment

Comments

@sgort
Copy link

sgort commented Jan 28, 2021

List of topics / elements I came across when going through waardepapieren service and may require documentation updates that I will try to add with PRs.

I closed the original issue. In this new issue the previous items have been copied and I supplement them with things that I encounter in the repo here that I will now go through.

  • Meaning clusters, domains, environments, installations
  • Usage Kubernetes dashboard applicable provider
  • Meaning checkbox Component has been installed in Add new installations
  • Environment cannot contain capital letters or spaces
  • Only the domain name {{cluster name}} - {{name organization}}. commonground.nu is automatically placed in the DNS
  • The components page of a cluster shows the cluster-specific components, as opposed to a global component that is shown under 'general'
  • Certificates for commonground.nu support a maximum of 1 subdomain level
  • How to identify the dependencies of components that are not automatically loaded
  • How to understand specific configuration and / or installation such as after installation of Waardepapieren service (ie load database schema) and BRP (ie load datafixtures)
  • Time out dashboard while running / waiting for load datafixtures of BRP
  • How to create an API authorization key to use for POST requests creating a certificate resource
  • How to add your own testing organization
@sgort
Copy link
Author

sgort commented Feb 4, 2021

  • make the api key that is generated for the cluster easy to find in the dashboard interface
  • explain that default installation of serivce(s) like BRP doesn't come with test data, as a result a test via postman will give you an internal server error
  • brp mock has a hard dependency on a component, namely the national tables catalog (ltc), so extra components are needed to be installed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant