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

Document ignition-validate usage (was: Document better how to use the Docker image of ct to generate the Ignition config) #72

Closed
pothos opened this issue Apr 3, 2020 · 2 comments · Fixed by flatcar/flatcar-website#314
Labels
good first issue Get started with Flatcar contribution with this issue. kind/docs kind/feature A feature request

Comments

@pothos
Copy link
Member

pothos commented Apr 3, 2020

Current situation

For new users it is mostly unclear in the docs which format is used: either the ready-to-use Ignition config as JSON or, more often, the Container Linux Config as YAML which needs to be converted to Ignition first.
The docs about the Container Linux Config mention how to use the transpiler but not that there is a Docker image for easy usage: https://docs.flatcar-linux.org/os/provisioning/
The docs about the transpiler don't mention the Docker image either: https://docs.flatcar-linux.org/container-linux-config-transpiler/doc/overview/

Impact
When a config is presented in the docs, it is not clear sometimes that it needs transpilation to be used.
How transpilation is used in an easy way with Docker is not explained.

Ideal future situation
Show two tabs, one with CL Config and one with Ignition (see for example https://coreos.com/os/docs/latest/adding-users.html).

Include how to use the transpiler with Docker in https://docs.flatcar-linux.org/container-linux-config-transpiler/doc/getting-started/

cat cl-config.yaml | docker run --rm -i quay.io/coreos/ct:latest-dev > ignition.json

Consider to host the Docker image on our quay.io account.
https://quay.io/repository/coreos/ct

Implementation options

Additional information
There is also a validator image that seems to be used on https://coreos.com/validate/:
https://quay.io/repository/coreos/ignition-validate

Consider to document it in the Flatcar docs or even publish a similar web page, too.

@vbatts
Copy link
Member

vbatts commented May 8, 2020

Yes, please. This is a learning curve.

@tormath1 tormath1 added the good first issue Get started with Flatcar contribution with this issue. label Jan 28, 2022
@pothos
Copy link
Member Author

pothos commented Mar 24, 2022

ct Docker image in docs is done

  • The validation with ignition-validate is not yet mentioned in the docs.

Jeremi made a PoC for a transpilation website.

@pothos pothos changed the title Document better how to use the Docker image of ct to generate the Ignition config Document ignition-validate usage (was: Document better how to use the Docker image of ct to generate the Ignition config) Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Get started with Flatcar contribution with this issue. kind/docs kind/feature A feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants