[go: up one dir, main page]
Skip to content

Convenience script to configure Workspaces setup

MR: Pending

Description

As a user, I want an convenience script so that I can easily configure Workspaces and get started; especially for the first time.

Create an installation script which will configure everything -

  • It will assume you have a Kubernetes cluster created (each organization has different requirements so no point in trying to tackle this)
  • Setup an agent project. Configure it based on user input.
  • The script will create the necessary OAuth application
  • Generate the necessary SSH Host key
  • Generate the certificates based on the domain
  • and all other things required ...
  • Configure and install the Helm charts in the Kubernetes cluster

This way, anyone who wants to try out Workspaces, can use the script to get an environment up and running and if they want to configure it for advanced use-cases, they can do these steps manually.

Our goal should be to make this script as flexible as possible and should cover all use-cases. However, we can start with a small scope.

There also has to be buy-in from the team that any new feature they add to Workspaces setup, needs to be supported by this script in a timely manner.

Maybe some sort of "SLAs" should be defined for that? That instills confidence in folks to use such things knowing that this will be supported.

Acceptance Criteria

  • Convenience script to configure Workspaces setup
  • Should be platform independent

Technical Requirements

  • Writing shell scripts is usually the way but they are not maintainable.
  • We need platform independent binary. So writing it in Go would be a good option.

Design Requirements

TODO: Fill out or delete (optional) [If applicable, please provide a link to the design specifications for this feature/enhancement.]

Impact Assessment

TODO: Fill out or delete (optional) [Please describe the impact this feature/enhancement will have on the user experience and/or the product as a whole.]

User Story

TODO: Fill out or delete (optional) [Provide a user story to illustrate the use case for this feature/enhancement. Include examples to help communicate the intended functionality.]

Edited by Vishal Tak