MCLOUD-6215: Add examples in devdocs how to downgrade service versions #7657
Conversation
|
An admin must run tests on this PR before it can be merged. |
jeff-matthews
added
the
Internal Dev
Co-authored-by: Margaret Eker <[email protected]>
* Revisions to new change version topic - Added note about support ticket requirement on Pro Staging and Prod - Added note about checking ES composer package compatiblity on ES version change - Updates for DevDocs styles and conventions - Editorial updates * Update src/cloud/project/project-conf-files_services.md
Co-authored-by: Margaret Eker <[email protected]>
meker12
added
the
Waiting for Response
|
Waiting for technical review. |
| @@ -43,19 +43,19 @@ elasticsearch: | |||
|
|
|||
| ## Service values | |||
|
|
|||
| You must provide the _type_ values: service _name_ and _version_. If the service uses persistent storage, then you must provide a _disk_ value. Use the following format: | |||
| You must provide the _type_ values: _service-name_ and _version_. If the service uses persistent storage, then you must provide a _disk_ value. Use the following format: | |||
There was a problem hiding this comment.
Why did we change this to service-name here and in the YAML example below but leave it as just name in the documentation (eg, the heading on line 54 and the following two paragraphs [56 and 58]).
I think name is fine, but either way we should be consistent.
There was a problem hiding this comment.
Yes, need to review all examples, but now we have 2 <name> in this schema https://devdocs.magento.com/cloud/project/project-conf-files_services.html#service-values what is wrong because service names are limited (redis, mysql, elasticsearch and rabbitmq), when service id can have any value with alphanumeric characters.
Probably we may add this as
<service-id>:
type: <name>:<version>
disk: <value-MB>
There was a problem hiding this comment.
@meker12 can you please suggest better naming for fields to avoid <name> for two different fields
There was a problem hiding this comment.
service-id -- works. Added suggestions to PR.
| git push origin <branch-name> | ||
| ``` | ||
|
|
||
| ### Downgrade version |
There was a problem hiding this comment.
I feel like we should add a callout here reminding users that this is a destructive process and will delete their existing database data.
There was a problem hiding this comment.
We have this information in the description of the service id field
Renaming a service in the services.yaml file permanently removes the following:
- The existing service before creating a new service with the new name you specify.
- All existing data for the service is removed. We strongly recommend you snapshot your environment before you change the name of an existing service.
Probably we need to duplicate it
There was a problem hiding this comment.
I clarified the first bullet, and added a warning after step 1 of the "Rename" procedure. See most recent commits.
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: approved
labels
m2-community-project
bot
added
Progress: review
and removed
Progress: changes requested
labels
Co-authored-by: Margaret Eker <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>
|
running tests |
|
Hi @NadiyaS, thank you for your contribution! |
meker12
added
2.x
Technical
Purpose of this pull request
Add description and examples to cloud devdocs about downgrading service versions in .magento.app.yaml and services.yaml
Affected DevDocs pages
whatsnew
Added instructions for upgrading and downgrading the software version for installed service versions. See Change service versions