You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by GitBox <gi...@apache.org> on 2022/04/11 14:25:49 UTC
[GitHub] [camel-k] Gre8t opened a new pull request, #3187: added a file-config doc
Gre8t opened a new pull request, #3187:
URL: https://github.com/apache/camel-k/pull/3187
<!-- Description -->
<!--
Enter your extended release note in the below block. If the PR requires
additional action from users switching to the new release, include the string
"action required". If no release note is required, write "NONE".
You can (optionally) mark this PR with labels "kind/bug" or "kind/feature" to make sure
the text is added to the right section of the release notes.
-->
**Release Note**
```release-note
NONE
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-k] Gre8t commented on a diff in pull request #3187: added a file-config doc
Posted by GitBox <gi...@apache.org>.
Gre8t commented on code in PR #3187:
URL: https://github.com/apache/camel-k/pull/3187#discussion_r848006029
##########
docs/modules/ROOT/pages/cli/file-based-config.adoc:
##########
@@ -0,0 +1,5 @@
+= File Based Configuration
+
+File-based configuration is used to set command flags. Flag values do not need to be entered on a regular basis. The file is read on Kamel startup and the flags are set accordingly.
+
+To configure this flag, create a file named kamel-config.yaml on the same directory as your integration. The file must contain a yaml structure as shown in ./kamel-config.yaml.
Review Comment:
Thank you.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-k] squakez merged pull request #3187: added a file-config doc
Posted by GitBox <gi...@apache.org>.
squakez merged PR #3187:
URL: https://github.com/apache/camel-k/pull/3187
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-k] tadayosi commented on a diff in pull request #3187: added a file-config doc
Posted by GitBox <gi...@apache.org>.
tadayosi commented on code in PR #3187:
URL: https://github.com/apache/camel-k/pull/3187#discussion_r851705971
##########
docs/modules/ROOT/pages/cli/file-based-config.adoc:
##########
@@ -0,0 +1,24 @@
+= File Based Configuration
+
+File-based configuration is used to set command flags. Flag values do not need to be entered on a regular basis. The file is read on Kamel startup and the flags are set accordingly.
+
+The file's default name is `kamel-config.yaml` . Which should be placed in either of this directory structure:
+
+ - `~/.kamel/`
+ - `./.kamel/`
+ - `.`
+
+it can be overriden by setting an env value `KAMEL_CONFIG_NAME` to file path.
Review Comment:
overriden -> overridden
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-k] Gre8t commented on a diff in pull request #3187: added a file-config doc
Posted by GitBox <gi...@apache.org>.
Gre8t commented on code in PR #3187:
URL: https://github.com/apache/camel-k/pull/3187#discussion_r851739797
##########
docs/modules/ROOT/pages/cli/file-based-config.adoc:
##########
@@ -0,0 +1,24 @@
+= File Based Configuration
+
+File-based configuration is used to set command flags. Flag values do not need to be entered on a regular basis. The file is read on Kamel startup and the flags are set accordingly.
+
+The file's default name is `kamel-config.yaml` . Which should be placed in either of this directory structure:
+
+ - `~/.kamel/`
+ - `./.kamel/`
+ - `.`
+
+it can be overriden by setting an env value `KAMEL_CONFIG_NAME` to file path.
Review Comment:
fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-k] Gre8t commented on pull request #3187: added a file-config doc
Posted by GitBox <gi...@apache.org>.
Gre8t commented on PR #3187:
URL: https://github.com/apache/camel-k/pull/3187#issuecomment-1095123179
@astefanutti
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-k] tadayosi commented on a diff in pull request #3187: added a file-config doc
Posted by GitBox <gi...@apache.org>.
tadayosi commented on code in PR #3187:
URL: https://github.com/apache/camel-k/pull/3187#discussion_r847936367
##########
docs/modules/ROOT/pages/cli/file-based-config.adoc:
##########
@@ -0,0 +1,5 @@
+= File Based Configuration
+
+File-based configuration is used to set command flags. Flag values do not need to be entered on a regular basis. The file is read on Kamel startup and the flags are set accordingly.
+
+To configure this flag, create a file named kamel-config.yaml on the same directory as your integration. The file must contain a yaml structure as shown in ./kamel-config.yaml.
Review Comment:
You should remove the empty `kamel-config.yaml` file. Rather the doc should include the content of a config file and some examples on how to use the cli with the config file.
You can look at other camel-k doc such as:
https://camel.apache.org/camel-k/next/cli/modeline.html
to have an idea on how it should be written.
##########
docs/modules/ROOT/pages/cli/file-based-config.adoc:
##########
@@ -0,0 +1,5 @@
+= File Based Configuration
Review Comment:
This doc needs to be linked from `docs/modules/ROOT/nav.adoc` so that it shows up in the left nav menu.
##########
docs/modules/ROOT/pages/cli/file-based-config.adoc:
##########
@@ -0,0 +1,5 @@
+= File Based Configuration
+
+File-based configuration is used to set command flags. Flag values do not need to be entered on a regular basis. The file is read on Kamel startup and the flags are set accordingly.
+
+To configure this flag, create a file named kamel-config.yaml on the same directory as your integration. The file must contain a yaml structure as shown in ./kamel-config.yaml.
Review Comment:
Also, you should write that `kamel-config.yaml` is the default file name and you can change it with the `KAMEL_CONFIG_NAME` env var.
You should also explain here that the default config paths are: `.`, `./.kamel`, and `$HOME/.kamel/` and you can change them with the `KAMEL_CONFIG_PATH` env var as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org