Skip to content

Commit b698a9c

Browse files
authored
Merge pull request #7029 from umbraco/cloud/flexibleEnvironment
Updated Cloud docs to reflect changes coming with Flexible Environments
2 parents 34ff92a + 45148b7 commit b698a9c

File tree

62 files changed

+505
-389
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+505
-389
lines changed
60.1 KB
Loading

umbraco-cloud/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The easiest way to start with an Umbraco Cloud project is to take a [14-day free
3434

3535
Since everything is already set up for you, it is recommended that you get to know your project before you start building.
3636

37-
To start working with and building your site, you can either work directly in the backoffice on the Cloud environment or [clone down the project to your local machine](set-up/working-locally.md).
37+
You can either work directly in the backoffice on the Cloud environment or [clone down the project to your local machine](set-up/working-locally.md).
3838

3939
### Umbraco Cloud Portal Project
4040

umbraco-cloud/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@
8181

8282
## Deployments
8383

84-
* [Streamline Your Deployments](deployment/streamline-your-deployments.md)
8584
* [Deployment](deployment/README.md)
8685
* [Deploying between environments](deployment/cloud-to-cloud.md)
8786
* [Transferring Content, Media, Members, and Forms](deployment/content-transfer.md)
@@ -132,6 +131,7 @@
132131
* [Extraction error: Config transforms failing](troubleshooting/deployments/changes-not-being-applied.md)
133132
* [Extraction error: Data Type collisions](troubleshooting/deployments/colliding-datatypes.md)
134133
* [Dependency Exception](troubleshooting/deployments/dependency-exceptions.md)
134+
* [Merge Conflicts on Flexible Environments](troubleshooting/deployments/merge-conflicts-on-flexible-environments.md)
135135
* [Troubleshooting deployments failing with no error message](troubleshooting/deployments/deployment-failed.md)
136136
* [Troubleshooting duplicate dictionary items](troubleshooting/deployments/duplicate-dictionary-items.md)
137137
* [Troubleshooting language mismatches](troubleshooting/deployments/language-mismatch.md)

umbraco-cloud/databases/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Working with databases
22

33
{% hint style="info" %}
4-
The databases on your Umbraco Cloud environments are specific to their environment. This means that no matter what you have configured in the `connectionstring` in your `web.config` or `appSettings.json` file, we overwrite the connectionstring to use the SQL Azure Server we provide.
4+
The databases on your Umbraco Cloud environments are specific to their environment. This means that the connectionstring to use the SQL Azure Server is overwritten no matter what else is configured.
55
{% endhint %}
66

77
When working with Umbraco Cloud, the way you work with databases might differ from what you're used to. One important aspect of Umbraco Cloud is that you always work isolated to avoid interfering with colleagues or a running website. This includes the database as well.

umbraco-cloud/databases/backups.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,10 +160,10 @@ Make sure to check your environment and see if everything works as expected and
160160

161161
Use the following steps:
162162

163-
* Connect to your SQL Server using SQL Server Management Studio (SSMS).
164-
* Expand "Databases", right-click "Databases", then select "Import Data-tier Application...".
165-
* Proceed through the dialog, by browsing to the saved location of your `bacpac` file, and then setting the options appropriate to your configuration
166-
* Complete the import dialog and the database will be restored.
163+
1. Connect to your SQL Server using SQL Server Management Studio (SSMS).
164+
2. Expand "Databases", right-click "Databases", then select "Import Data-tier Application...".
165+
3. Proceed through the dialog, by browsing to the saved location of your `bacpac` file, and then setting the options appropriate to your configuration
166+
4. Complete the import dialog and the database will be restored.
167167

168168
{% hint style="info" %}
169169
If a `bacpac` restore fails in SQL server, ensure the 'Contained Database Authentication' flag is set to true for resolution.

umbraco-cloud/deployment/README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,32 @@ description: >-
66

77
# Deployment
88

9-
Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy core technology to move changes between environments. This follows a "left to right" model. Changes start in the local or left-most environment and are deployed to the production environment.
9+
Umbraco Cloud uses a deployment model based on Git, Kudu, and Umbraco Deploy to move changes between environments. This follows a left-to-right deployment approach. Changes start in the local or left-most environment and are deployed to the production/Live environment. This workflow is called the mainline.
1010

11-
![Left to right model](images/left-to-right.png)
11+
The mainline environments are used when building and deploying the initial website. Upgrades, both manual and automatic also go through the mainline environments.
1212

13-
## Deployment Approach
13+
Flexible environments can be used to work on features separate from the mainline. This is done without interfering with upgrades or other changes being worked on in the mainline.
14+
15+
![Left to right model](images/left-to-right-approach.png)
1416

15-
Umbraco Cloud separates metadata and content during deployment. Metadata includes Document Types, Templates, Forms, Views, and config files. Content includes content items and media.
17+
## Deployment Approach
1618

17-
**Key Terms:**
19+
Umbraco Cloud separates schema and content during deployment. Schema includes Document Types, Templates, Forms, Views, and config files. Content includes content items and media.
1820

19-
* **Deploy:** Moves metadata between environments using a Git client or the Umbraco Cloud Portal.
20-
* **Transfer:** Moves content and media directly via the Umbraco backoffice.
21+
* **Deploy:** Moves schema between environments using a Git client or the Umbraco Cloud Portal.
22+
* **Transfer:** Move content and media directly via the Umbraco backoffice.
2123

22-
**Deployment Types:**
24+
### Types of Deployments
2325

24-
* **Metadata Deployment:** Metadata, including Document Types, Templates, Forms, Views, and config files, is stored in a Git repository. These are **deployed** between environments using a Git client or the Umbraco Cloud Portal.
25-
* **Content and Media Transfer:** Content and Media items are **not** stored in the Git repository. Instead, they must be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once all required items are queued, the **Deployment** Dashboard in the **Content** section is used to complete the transfer.
26+
| Schema Deployments | Content and Media Transfers |
27+
| ----------- | ------------- |
28+
| Schema is stored in a Git repository. These are **deployed** between environments using a Git client or the Umbraco Cloud Portal. | Content and Media items are not stored in the Git repository. They must be **transferred** directly from the Umbraco backoffice using the **Queue for Transfer** option. Once queued, use the **Deployment** Dashboard in the **Content** section to complete the transfer. |
2629

27-
Content editors do not need Umbraco Cloud Portal access. They can manage content through the backoffice, while developers handle metadata deployments via Git.
30+
Content editors do not need Umbraco Cloud Portal access. They can manage content through the backoffice, while developers handle schema deployments via Git.
2831

29-
### Deploying Metadata
32+
### Deploying Schema
3033

31-
The source and target environments must be in sync before transferring content and media. Deploy metadata first to ensure consistency.
34+
The source and target environments must be in sync before transferring content and media. Deploy schema first to ensure consistency.
3235

3336
* [Deploy changes from Local to Cloud](local-to-cloud.md)
3437
* [Deploy changes between Cloud environments](cloud-to-cloud.md)
@@ -56,7 +59,7 @@ Some deployments can trigger an Umbraco Cloud environment to restart. The table
5659
| Action: | Application Restart? |
5760
| ----------------------------------- | -------------------- |
5861
| Config file change | Yes |
59-
| Metadata deployment | No |
62+
| Schema deployment | No |
6063
| File change (for example, CSS file) | No |
6164
| Content or Media transfer | No |
6265

@@ -79,4 +82,3 @@ The `name` attribute in the `umbraco-cloud.json` can be updated to clarify deplo
7982
![clone dialog](images/change-env-name-v8.png)
8083

8184
***
82-

umbraco-cloud/deployment/cloud-to-cloud.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,55 @@
22
updatedLinks: true
33
---
44

5-
# Deploying between environments
5+
# Deploying between Environments
66

7-
When your are Working in your Development environment, changes made through the Backoffice are automatically detected and committed to the site's Git repository. This includes Umbraco-specific items like Document types and templates.
7+
When you are working in your Cloud environment, changes made through the Backoffice are automatically detected and committed to the site's Git repository. This includes Umbraco-specific items like Document Types and Templates. These changes are also referred to as metadata.
88

9-
Changes made on your Cloud environments will show up in the Umbraco Cloud portal. You'll be able to see what files have been added/changed and who made the changes.
9+
## Deploying between Mainline Environments
1010

11-
To deploy metadata changes from one Cloud environment to another, click the **'Deploy changes to ..'** button on the environment where the changes have been made.
11+
Changes made in your Cloud environments will appear in the Umbraco Cloud portal. You can see what files have been added or changed and who made the changes.
12+
13+
To deploy metadata changes from one Cloud environment to another, click the **Deploy changes** button on the environment where the changes were made.
1214

1315
<figure><img src="../.gitbook/assets/image (39).png" alt=""><figcaption></figcaption></figure>
1416

15-
The deployment initiates, and you can see the process in the **Overview of your project.**
17+
The deployment starts, and you can follow the progress in the **Overview** section of your project.
1618

1719
<figure><img src="../.gitbook/assets/image (41).png" alt="Deployment in progress"><figcaption><p>Deployment in progress</p></figcaption></figure>
1820

19-
Once it's done, the changes will be deployed to the next Cloud environment. If you have more Cloud environments, follow the same procedure to deploy the changes up to your Live site.
21+
Once complete, the changes are deployed to the next Cloud environment in the deployment flow. If you have additional environments, repeat this process to deploy the changes through each environment.
22+
23+
## Syncing Changes Between Mainline and Flexible Environment
24+
25+
When working with a flexible environment alongside your mainline environments, it's important to keep them aligned to avoid conflicts and ensure consistent deployments.
26+
27+
If any changes have been made in a mainline environment those changes must be pulled into the flexible environment before pushing updates back. The changes can be updated Document Types, content, or other schema changes.
28+
29+
![Pull changes from Mainline Environment](images/pull-changes-from-mainline.png)
30+
31+
If what you've been working on in the flexible environment has also been changed in the mainline, a merge conflict will occur. These conflicts need to be resolved before you can continue with the deployment. For information on how to resolve them, see the [Merge Conflicts on Flexible Environments](../troubleshooting/deployments/merge-conflicts-on-flexible-environments.md) article.
32+
33+
Once you’ve completed your feature or update in the flexible environment and it’s synced with the latest mainline changes:
34+
35+
* Push your changes from the flexible environment to the mainline environment.
36+
* From there, the changes become part of the regular deployment flow.
37+
38+
![Push changes to the Mainline Environment](images/push-changes-to-mainline.png)
2039

2140
## Important Notes
2241

23-
When you deploy, for example, from your Development environment to your Live environment, changes are made to the Live environment. These changes will then be merged back into the Development environment.
42+
When you deploy, for example, from your left-most mainline environment to your Live environment, changes are made to the Live environment. These changes will then be merged back into the left-most mainline environment.
2443

25-
Here are the automatic steps Umbraco Cloud goes through when you hit the _"Deploy changes to .."_ button:
44+
Here are the automatic steps Umbraco Cloud goes through when you hit the _"Deploy changes"_ button:
2645

2746
* Before pushing your changes from the source environment, the engine running Umbraco Cloud - **Umbraco Deploy** - looks for changes in the repository on the target environment
2847
* If changes are found, Umbraco Deploy _merges_ the changes from the target environment into the repository on the source environment.
2948
* After the merge, the changes from the source environment are pushed to the repository on the target environment.
3049
* Finally, the changes pushed to the target repository are extracted to the site, and you will now see your changes reflected in the Backoffice and on the Frontend.
3150

32-
If you have more than one Umbraco Cloud environment, we strongly recommend that you **only make changes to metadata on the Development environment**. Making changes directly on your Staging and/or Live environments can cause merge conflicts when you deploy from your Development environment.
51+
It is recommended that you **only make changes to metadata on the left-most mainline environment or a flexible environment**. Making changes directly on other mainline environments can cause merge conflicts when you deploy.
3352

34-
{% hint style="danger" %}
53+
{% hint style="warning" %}
3554
It is important to be aware of how deletions work between environments. Some deletions are environment-specific and others are not. For more information see the [Deploying Deletions article](deploying-deletions.md).
3655
{% endhint %}
3756

0 commit comments

Comments
 (0)