[Don't merge] Add component yaml configuration definition with connection env renaming guide #1684
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nashaath
reviewed
Jan 21, 2025
en/docs/develop-components/manage-component-source-configurations.md
Outdated
Show resolved
Hide resolved
Nashaath
reviewed
Jan 21, 2025
en/docs/develop-components/manage-component-source-configurations.md
Outdated
Show resolved
Hide resolved
Nashaath
reviewed
Jan 21, 2025
en/docs/develop-components/manage-component-source-configurations.md
Outdated
Show resolved
Hide resolved
Nashaath
reviewed
Jan 21, 2025
| |-------------------------------|--------------|----------------------------------------------------------------------------------| | ||
| | **env** | Optional | Array of env variable confiuration | | ||
| | ** name** | Required | A unique name starting with a letter or an underscore, containing letters, numbers and underscore for the environment variable name | | ||
| | ** valueFrom** | Required | Value source for the env variable | |
There was a problem hiding this comment.
Can we say "The source of the environment variable value."?
Nashaath
reviewed
Jan 21, 2025
| | ** name** | Required | A unique name starting with a letter or an underscore, containing letters, numbers and underscore for the environment variable name | | ||
| | ** valueFrom** | Required | Value source for the env variable | | ||
| | ** connectionRef** | Required | Connection reference value source definition | | ||
| | ** name** | Required | Choreo connection name to refer the value from | |
There was a problem hiding this comment.
Can we say "The name of the Choreo connection to reference the value from."?
There was a problem hiding this comment.
Yes. I'll update.
Nashaath
reviewed
Jan 21, 2025
| | ** valueFrom** | Required | Value source for the env variable | | ||
| | ** connectionRef** | Required | Connection reference value source definition | | ||
| | ** name** | Required | Choreo connection name to refer the value from | | ||
| | ** key** | Required | Choreo connection configuration key to refer the value from. Refer to [connection configurations](https://wso2.com/choreo/docs/develop-components/sharing-and-reusing/use-a-connection-in-your-service/) or see in-line in-line developer guide displayed during connection creation to discover available keys | |
There was a problem hiding this comment.
Suggestion:
"The Choreo connection configuration key to reference the value from. For details on available keys, see Consume a service through a connection or the inline developer guide."
Nashaath
reviewed
Jan 21, 2025
en/docs/develop-components/manage-component-source-configurations.md
Outdated
Show resolved
Hide resolved
Nashaath
reviewed
Jan 21, 2025
en/docs/develop-components/sharing-and-reusing/use-a-connection-in-your-service.md
Outdated
Show resolved
Hide resolved
Nashaath
reviewed
Jan 21, 2025
en/docs/develop-components/sharing-and-reusing/use-a-connection-in-your-service.md
Outdated
Show resolved
Hide resolved
Nashaath
reviewed
Jan 21, 2025
en/docs/develop-components/sharing-and-reusing/use-a-connection-in-your-service.md
Outdated
Show resolved
Hide resolved
Nashaath
reviewed
Jan 21, 2025
| !!! note | ||
| Runtime configurations are supported only from component.yaml v1.1. | ||
|
|
||
| When environment variable value source is specified using `connectionRef`, the connection environment variable will be renamed into the given environment name. For example, in above sample `component.yaml` file, `CHOREO_HR_CONNECTION_SERVICEURL` variable from the `hr-connection` will be renamed to `HR_SERVICE_URL`. |
There was a problem hiding this comment.
Suggestion:
When an environment variable value is specified using connectionRef, the connection's environment variable is renamed to the environment variable name defined in the configuration section. For example, in the sample component.yaml file given above, the CHOREO_HR_CONNECTION_SERVICEURL variable in the hr-connection is renamed to HR_SERVICE_URL.
Nashaath
reviewed
Jan 21, 2025
Co-authored-by: Nisrin <[email protected]>
Co-authored-by: Nisrin <[email protected]>
Co-authored-by: Nisrin <[email protected]>
Co-authored-by: Nisrin <[email protected]>
Co-authored-by: Nisrin <[email protected]>
Co-authored-by: Nisrin <[email protected]>
Co-authored-by: Nisrin <[email protected]>
Nashaath
approved these changes
Jan 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Addresses: https://github.com/wso2-enterprise/choreo/issues/32895