Add disclaimer about customer-owned and spryker-owned variables #1942
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
feversocial
requested review from
VadymSachenko,
lenadoc,
AlexSlawinski and
andriitserkovnyi
as code owners
feversocial
added
in tech review
|
|
||
| Customer-owned variables are created and managed by you - the onboarded customer or implementation partner. You have full control over these variables and can add or edit them according to your needs. However, please note that changes to these variables do not automatically propagate into the running environment. To apply changes made to your environment variables, you'll need to run an ECS-updater-* pipeline in order to bring them to the containers (full re-deploy would also do the trick, of course). This process does not require Spryker Cloud or support intervention. | ||
|
|
||
| On the other hand, Spryker-owned environment variables should not be altered directly in the Parameter Store. These variables have been configured by Spryker for the optimal operation of the Cloud Commerce OS. Any change made directly to these variables can introduce inconsistencies and potential issues in Cloud Operations. |
There was a problem hiding this comment.
in optimal situations (proper IAM roles, and well-migrated old vars in case of existing customers), customers won't see those variables if they access the Param Store. they will have only the right to CRUD their own vars under the dedicated paths.
Worst case scenario, if these variables are still visible, the IAM roles won't let them edit them.
|
|
||
| On the other hand, Spryker-owned environment variables should not be altered directly in the Parameter Store. These variables have been configured by Spryker for the optimal operation of the Cloud Commerce OS. Any change made directly to these variables can introduce inconsistencies and potential issues in Cloud Operations. | ||
|
|
||
| If there is a need to modify a Spryker-owned environment variable, it must be done through Terraform to ensure proper application and consistency. However, such changes require Spryker Cloud or support intervention, as it needs to be coordinated with our DevOps team. |
There was a problem hiding this comment.
remove the terraform part.
i suggest :
If there is a need to modify a Spryker-owned environment variable, it must be done through Spryker Cloud or Support intervention, as it needs to be coordinated with our DevOps team to ensure proper application and consistency.
Updated, considering comments from Hatem
lenadoc
reviewed
Jun 26, 2023
|
|
||
| When working with environment variables in the Spryker Cloud Commerce OS, it's important to understand that there are two types of variables: those owned by the customer and those owned by Spryker. | ||
|
|
||
| Customer-owned variables are created and managed by you - the onboarded customer or implementation partner. You have full control over these variables and can add or edit them according to your needs. However, please note that changes to these variables do not automatically propagate into the running environment. To apply changes made to your environment variables, you'll need to run an ECS-updater-* pipeline in order to bring them to the containers (full re-deploy would also do the trick, of course). This process does not require Spryker Cloud or support intervention. |
There was a problem hiding this comment.
@feversocial "This process does not require Spryker Cloud or support intervention." - what does it mean "does not require Spryker Cloud intervention"?
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.
PR Description
TBD
Checklist