Support for ESC environments in the Stack custom resource

[ringods]

Hello!

• Vote on this issue by adding a 👍 reaction
• If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

A normal stack config file can contain two top level entries:

config:
   <ns>:<key>: <value>
environment:
  - <name-of-esc-environment>
  - <name-of-other-esc-environment>

The current custom resource definition for Stack contains a property config that you can use to configure stack config values. But all usages of the word environment in the CRD yaml file refer to environment variables. As far as I can see from the CRD, there is no option to configure the list of ESC enviroments to use for the stack.

Affected area/feature

PKO Stack CRD

[EronWright]

This looks to be pretty straightforward. The autoapi appears to have support for adding environment(s) to a stack (see code).

[ringods]

Worth adding this before PKO 2.0 GA!

[EronWright]

Regarding the Stack API, I think the recommendation of adding an environment array aligns well with how one does it at the stack configuration level (see docs). Interesting that it isn't pluralized (environments).

environment:
  - <your-project-name>/<your-environment-name>

We should decide on how this input should merge with a source-controlled stack configuration. I believe that configuration values are generally merged into the source-controlled configuration, and I would advocate for doing the same here. But in what order? There would be new agent-level API needed to take the environment spec.

Another mentionable is that the workspace should be replaced whenever environment is updated, as is the case with config values. The underlying reason is to have a hermetic environment.