Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 3.04 KB

solutions.md

File metadata and controls

45 lines (24 loc) · 3.04 KB

Solutions

There are 2 aspects to way solutions are managed in arete. First there is a local solutions.yaml file that tracks all solutions that have been added to arete from either the global GitHub solutions library or by calling arete solution get.

ALPHA NOTE: Right now the GitHub repo is private and thusly you need to add your GitHub personal access token to the config file. See: Config Doc

Listing available solutions

If you wish to see which solutions have been added and / or are available to arete, simple run the command arete solution list

Downloading a solution to modify locally

Sometimes you want to modify the solution package before you deploy it to your environment. You can get a local copy of the solution by calling: arete solution get https:/github.com/<GIT-USER>/<REPO-NAME>. This will add the solution to the local solutions list as well as downloading the solution into your local cache. The cache path is stored in the config file and can be changed at anytime.

Once you "get" the solution you modify the package and when you are ready to deploy the solution you can use kpt directly in the solution folder locally or you can run: arete soluiton deploy --from-cache <SOLUTION-NAME>

Adding a solution

If you wish to add a solution that is not listed in the global GitHub solution library you can create your own GitHub repo but a couple of required elements must exist:

  1. There must be a solution.yaml file stored at the root of the GitHub path provided that meets the solution.yaml yaml spec.
  2. There must be a Kptfile in the root of the GitHub path provided. (arete uses kpt to render and apply solutions)

Once your solution is structured correctly you can simple call: arete solution get https:/github.com/<GIT-USER>/<REPO-NAME>

  • NOTE: If your solution is stored in a sub-folder of your repo, then use the --sub-folder flag to provide the path. Also, if the solution is in a different branch then provide the branch name with the --branch flag

Solution.yaml

See solution.yaml spec

Removing a solution

If you wish to remove a solution from the arete list then you will need to modify the locally cached solutions.yaml file. Find the file (defaults to your local home directory in a folder called .arete) and remove the solution from the yaml list

Prompting the user

Since arete uses kpt to render the final deployments before applying the solutions we rely on the Kptfile pipeline process to determine if there is any information needed to be updated by user input. The Kptfile pipeline allows for mutators that can use a ConfigPath to a YAML file for setting values through out the solution.

Arete will search the YAML file listed in the ConfigPath for any single line comment pattern. This process looks similar to the kpt setters function pattern.

If you want to prompt a user to update the value of templated value then add the comment # arete-prompt to the end of the key/value pair in any of your kpt mutators.