docs: add environment variables configuration page #6426
Conversation
Document all environment variables used by the Camel K operator, CLI, and runtime. This includes operator settings, proxy configuration, Maven options, and runtime environment variables. Fixes apache#6414
squakez
left a comment
There was a problem hiding this comment.
Nice work, thanks! We need to remove certain parts, but the operator section is good!
docs/modules/ROOT/nav.adoc
Outdated
| ** xref:configuration/runtime-config.adoc[Runtime configuration] | ||
| ** xref:configuration/runtime-resources.adoc[Runtime resources] | ||
| ** xref:configuration/runtime-version.adoc[Camel version] | ||
| ** xref:configuration/env-vars.adoc[Environment Variables] |
There was a problem hiding this comment.
I think this one belongs more to installation>advanced and we can name it Operator Tuning
There was a problem hiding this comment.
Even better. Don't add a new page. Put this content instead as a paragraph in the operator tuning page: https://camel.apache.org/camel-k/next/installation/advanced/advanced.html
| [[env-vars]] | ||
| = Environment Variables | ||
|
|
||
| The Camel K operator and CLI can be configured using environment variables. This page documents all the environment variables that can be used to customize the behavior of Camel K components. |
There was a problem hiding this comment.
This is operator only, we should remove the CLI.
|
|
||
| |`WATCH_NAMESPACE` | ||
| |_required_ | ||
| |The namespace(s) the operator watches for Integration resources. Required for operator startup. |
There was a problem hiding this comment.
Add a note telling that when missing, the operator is watching all namespaces.
| |=== | ||
| |Variable |Default |Description | ||
|
|
||
| |`MAVEN_CMD` |
There was a problem hiding this comment.
This one should be omitted. The existence of the command is exclusively for unit test.
| |Additional JVM options passed to Maven during builds. | ||
| |=== | ||
|
|
||
| [[cli-env-vars]] |
There was a problem hiding this comment.
Let's remove these one and focus only on the operator.
| |=== | ||
|
|
||
| [[build-env-vars]] | ||
| == Build Environment Variables |
There was a problem hiding this comment.
These one should not be configured by the user. Please, remove.
| |Path to the Java installation. Used for keystore operations during builds. | ||
| |=== | ||
|
|
||
| [[runtime-env-vars]] |
There was a problem hiding this comment.
Please, remove this section. Those env vars are controlled typically by traits instead.
| value: "true" | ||
| ---- | ||
|
|
||
| === For Integrations |
There was a problem hiding this comment.
Remove this section. The goal is the operator tuning.
- Rename page to 'Operator Tuning' and move to installation/advanced - Remove CLI, Proxy, Maven, Build, Runtime sections per reviewer feedback - Focus documentation on operator-specific environment variables only - Add note that WATCH_NAMESPACE defaults to watching all namespaces
|
Thanks @squakez for the detailed review! I've addressed all the feedback:
Please let me know if there's anything else that needs adjustment! |
Per reviewer feedback, instead of creating a new page, add the operator environment variables documentation as a section in the existing fine-tuning page (advanced.adoc).
|
Updated! Instead of creating a new page, I've added the environment variables section directly to the existing |
|
Good work! That page will serve in the future to include any new env var introduced in the operator. Thanks! |
Description
This PR adds comprehensive documentation for all environment variables used by Camel K, as requested in #6414.
Changes
docs/modules/ROOT/pages/configuration/env-vars.adocEnvironment Variables Documented
Operator
WATCH_NAMESPACE,NAMESPACE,POD_NAMEKAMEL_OPERATOR_ID/OPERATOR_IDKAMEL_BASE_IMAGE/RELATED_IMAGE_BASECAMEL_K_SYNTHETIC_INTEGRATIONSLOG_LEVELKAMELET_CATALOG_DIRProxy
HTTP_PROXY,HTTPS_PROXY,NO_PROXYMaven
MAVEN_CMD,MAVEN_WRAPPER,MAVEN_OPTSCLI
KUBECONFIG,KAMEL_CONFIG_NAME,KAMEL_CONFIG_PATHGITHUB_TOKENBuild
DOCKER_CONFIG,JAVA_HOMERuntime
CAMEL_K_OPERATOR_ID,CAMEL_K_VERSION,CAMEL_K_INTEGRATIONCAMEL_K_RUNTIME_VERSION,CAMEL_K_MOUNT_PATH_*CAMEL_K_CONF,CAMEL_K_CONF_D,CAMEL_K_DIGESTHow to Test
Fixes #6414