search

SAP / configuration-tools-for-gitops

This repository provides CoCo, a configuration management tool for dealing with many services across a large number of target environments. CoCo helps to align configurations and identify deviations (between environments as well as different commits).
Apache License 2.0
5 stars 1 forks source link

coco.yaml file #31

Open gedw99 opened 1 year ago

gedw99 commented 1 year ago

this looks really useful.

is there an example cooc.yaml file to get started learning this ?

blackhatcrazy commented 1 year ago

Hi gedw99,

first of all thank you for reaching out!

At the moment unfortunately our UX documentation is still lacking behind and we don't have a nice end-to-end example readily consumable.

I assume, you're referring to the component configuration file and not to the CLI configuration, right?

In that case, component configurations are very limited at the moment. You can only specify the component's name and the direct dependencies that the component consumes, e.g.

name: my-component
dependencies:
- first-dependency-that-I-consume
- second-dependency-that-I-consume
- ...

Currently, the file is only used for dependency graph generation and evaluation.

blackhatcrazy commented 1 year ago

However, if you were referring to the CLI configuration, you can inspect that by running

coco inspect

to obtain the current configuration that coco uses. You can either adjust the file (default location in $HOME/.coco, or pass a different configuration file by running coco --config ${my_config_file}.

blackhatcrazy commented 1 year ago

Feel free to reach out if there are any details we can help you with.

gedw99 commented 1 year ago

thanks @blackhatcrazy

Yeah i just wanted an example to kick the tires as they say.

can start anywhere. I don't need a fancy UX or anything. I code golang so can work out the ins and outs.

Maybe a folder called "example" that does basic stuff would be nice..

Maybe put that in example with a basic readme:

name: my-component
dependencies:
- first-dependency-that-I-consume
- second-dependency-that-I-consume
- ...
gedw99 commented 1 year ago

You can only specify the component's name and the direct dependencies that the component consumes, e.g.

Its a start :)

I can also help extend things from there too. If there is a very basic TODO, i can see the holes and start to contrib...

blackhatcrazy commented 1 year ago

Given we're fairly people-constrained, we're always happy for contributions if you want to chip in. I'll see to fill the issues with some features and fixes we have in mind.

gedw99 commented 1 year ago

Ok thanks @blackhatcrazy

gedw99 commented 1 year ago

Sounds good. I will try a few things out