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

Consider a recommended name for OPA server configuration file #6959

Closed
anderseknert opened this issue Aug 26, 2024 · 0 comments · Fixed by #6966
Closed

Consider a recommended name for OPA server configuration file #6959

anderseknert opened this issue Aug 26, 2024 · 0 comments · Fixed by #6966

Comments

@anderseknert
Copy link
Member

The OPA docs provide no suggestions on what to name the OPA server configuration file. While this may not matter to OPA, as configuration must be provided explicitly via the --config-file flag, there are other tools for which it would be helpful to be able to detect and OPA configuration file merely by it's filename. One example of this would be the JSON schema store, where we could publish the JSON schema for the OPA configuration file format. But the catalog expects a fileMatch property to determine if a file is an OPA configuration file or not. Another example would be Regal, where we might want to lint OPA configurations as part of linting a project or workspace.

I guess it could also be considered if opa run --server . automatically should pick up a config file given one with the well-known name exists. But that can be a later concern. For now, I'm suggesting we update the docs to suggest a name for an OPA configuration file, and explain that while it's not mandatory, it can provide benefits for tooling, and from that the overall development experience.

As for the name, opa-conf.yaml is used by Styra DAS, so it has some adoption already. But it wouldn't necessarily have to be a single name. If there are other suggestions for names or even patterns, we can consider recommending a few of them as "well-known".

anderseknert added a commit to anderseknert/opa that referenced this issue Aug 27, 2024
And update some references throughout the docs.

Fixes open-policy-agent#6959

Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert added a commit to anderseknert/opa that referenced this issue Aug 27, 2024
And update some references throughout the docs.

Fixes open-policy-agent#6959

Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert added a commit that referenced this issue Aug 27, 2024
And update some references throughout the docs.

Fixes #6959

Signed-off-by: Anders Eknert <anders@styra.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant