Skip to content

Commit a8fa303

Browse files
authored
Merge pull request #7009 from umbraco/flex/updateEnvRefs
Update environment references where needed
2 parents 9052559 + 292898d commit a8fa303

File tree

8 files changed

+69
-80
lines changed

8 files changed

+69
-80
lines changed

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/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 & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,6 @@ Once you have uploaded a backup, you might want to restore it to one of your env
7979

8080
<figure><img src="../.gitbook/assets/image (72).png" alt="Choose which environment to restore the backup on"><figcaption><p>Choose which environment to restore the backup on</p></figcaption></figure>
8181

82-
83-
84-
8582
3. **Optional:** Create a Cloud Backup of the selected environment's database before restoring the backup.
8683
4. Click **"Restore backup"**
8784

@@ -93,10 +90,10 @@ Make sure to check your environment and see if everything works as expected and
9390

9491
Use the following steps:
9592

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

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

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,34 @@ updatedLinks: true
44

55
# 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 your 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+
Changes made on your Cloud environments will show up in the Umbraco Cloud portal. You'll can see what files have been added/changed and who made the changes.
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+
To deploy metadata changes from one Cloud environment to another, click the **Deploy changes** button on the environment where the changes have been made.
1212

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

15-
The deployment initiates, and you can see the process in the **Overview of your project.**
15+
The deployment initiates, and you can follow the process in the **Overview of your project.**
1616

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

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.
19+
Once it's done, the changes will be deployed to the next Cloud environment in the deployment flow. If you have more Cloud environments, follow the same procedure to deploy the changes through each environment.
2020

2121
## Important Notes
2222

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.
23+
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.
2424

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

2727
* 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
2828
* If changes are found, Umbraco Deploy _merges_ the changes from the target environment into the repository on the source environment.
2929
* After the merge, the changes from the source environment are pushed to the repository on the target environment.
3030
* 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.
3131

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.
32+
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.
3333

34-
{% hint style="danger" %}
34+
{% hint style="warning" %}
3535
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).
3636
{% endhint %}
3737

umbraco-cloud/deployment/deploying-deletions.md

Lines changed: 30 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,36 @@ The databases are environment specific. During deployment across environments, U
1010

1111
The workflow described above does not recognize deletions of content and schema from the database. You'll need to delete the content and/or schema on all your environments to fully complete the deletion.
1212

13-
The main reason we do not delete schema and content on deployments is that it could lead to an unrecoverable loss of data. Imagine you delete a Document Type in your Development environment. Then, push this deletion to your Live environment, where many content nodes depend on the deleted Document Type. When the deployments go through, all those content nodes would be instantly removed. There is no option to roll back because the Document Type they rely on no longer exists. To prevent such situations, manual deletion is necessary. You must actively decide on each environment for the process to occur.
13+
The main reason not to delete schema and content on deployments is that it could lead to an unrecoverable loss of data.
14+
15+
Here's an example of what can happen when a Document Type is deleted and deployed:
16+
17+
* A Document Type is deleted in the left-most mainline environment.
18+
* This deletion is then pushed to the Live environment, where many content nodes depend on the deleted Document Type.
19+
* When the deployment is completed, all those content nodes would be instantly removed.
20+
21+
In the scenario described above, there is no option to roll back because the Document Type they rely on no longer exists. To prevent such situations, manual deletion is necessary. You must actively decide on each environment for the process to occur. Below is the same scenario explained in more detail.
1422

1523
## Example scenario
1624

17-
Let's say you've deleted a Document Type on your Development environment. Now, you want to deploy this deletion to the Live environment, along with some other changes you've made.
25+
The following example will build in the scenario outlined above, calling the left-most mainline environment the **Development** environment. In addition to the deletion, additional changes that have been made will also be deployed.
1826

1927
Before you deploy the changes, the Development environment will show that the following changes are ready to be deployed:
2028

2129
<figure><img src="../.gitbook/assets/image (42).png" alt=""><figcaption><p>Changes ready for deployment</p></figcaption></figure>
2230

23-
Following the **Activity log** in the browser, you'll notice the UDA file for the Document Type gets deleted. Additionally, other files with changes are copied to the new environment.
31+
Following the **Activity log** in the browser, you'll notice that the `.uda` file for the Document Type gets deleted. Additionally, other files with changes are copied to the Live environment.
2432

25-
Once the deployment is completed, you will notice the following:
33+
Once the deployment is completed, the following changes has taken place:
2634

27-
* The template is correctly updated
28-
* The Document Type you deleted on Development is still present in the backoffice on the Live environment
35+
* The template is correctly updated.
36+
* The Document Type you deleted on the Development environment is still present in the backoffice on the Live environment.
2937

30-
You might wonder why the Document Type that you have deleted, is still there. The reason is, that we only delete the associated UDA file and not the actual Document Type in the database.
38+
The reason for the Document Type to still be there is, that the associated `.uda` file is deleted. The Document Type still exists in the database.
3139

32-
To delete the Document Type from your entire project, you need to delete it from the backoffice of the other environments. When the Document Type has been deleted from the Backoffice of all the environments and no UDA file exists, you can consider it gone.
40+
To delete the Document Type from your entire project, you need to delete it from the backoffice of the other environments. When the Document Type has been deleted from the backoffice of all the environments and no `.uda` file exist, it is fully removed.
3341

34-
You should keep in mind that if you save your Document Type during the process, a UDA file is regenerated. This can recreate your deleted Document Type when deploying changes between environments.
42+
If you save your Document Type during the process, a new `.uda` file is generated. This can recreate your deleted Document Type when deploying changes between environments.
3543

3644
## Which deletions are deployed?
3745

@@ -41,44 +49,31 @@ Here's an overview of what happens when you deploy deletions to the next environ
4149

4250
### Deleting Schema (Document Types, Datatypes, etc.)
4351

44-
Deleted:
45-
46-
* The associated `.UDA` file
47-
48-
Not deleted:
49-
50-
* The entry in the database
51-
* The item will still be visible in the backoffice
52+
| Deleted | Not Deleted |
53+
| --------------------------- | ------------------------------------------------ |
54+
| The associated `.uda` file. | The entry in the database. |
55+
| | The item will still be visible in the backoffice.|
5256

5357
### Deleting a Template
5458

55-
Deleted:
56-
57-
* The associated `.UDA` file
58-
* The associated `.cshtml` file (the view file)
59-
60-
Not deleted:
61-
62-
* The entry in the database
63-
* The template file will be empty, but still be visible in the backoffice
59+
| Deleted | Not Deleted |
60+
| -------------------------------------------- | ----------------------------------------------------------------------- |
61+
| The associated `.uda` file. | The entry in the database. |
62+
| The associated `.cshtml` file (the view file)| The template file will be empty, but still be visible in the backoffice.|
6463

6564
### Deleting Files (CSS files, config files, etc.)
6665

67-
As these are **only** files, everything will be deleted in the next environment upon deployment.
66+
All files are deleted in the next environment upon deployment.
6867

6968
### Deleting Content and/or Media
7069

7170
Deletions of content and media won't be detected during deployments. You must manually delete them on each environment where removal is desired.
7271

7372
### Deleting Backoffice Languages
7473

75-
Deleted:
76-
77-
* The associated `.UDA` file
78-
79-
Not deleted:
80-
81-
* The entry in the database
82-
* The language will still be visible in the Backoffice/Content dashboard (for multilingual content)
74+
| Deleted | Not Deleted |
75+
| -------------------------- | ------------------------------------------------------------------------------------------------- |
76+
| The associated `.uda` file.| The entry in the database. |
77+
| | The language will still be visible in the Backoffice/Content dashboard (for multilingual content).|
8378

8479
Deleting the language in the backoffice on the target environment will ensure the environments are in sync.

umbraco-cloud/deployment/deployment-webhook.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
1-
---
2-
---
3-
41
# Deployment Webhook
52

6-
You can now configure a deployment webhook to be triggered upon successful deployments to any of your Umbraco Cloud environments. For example, when deploying from your local environment to your Cloud Development environment. Upon successful deployment, general information about the deployment will be posted in a JSON format to the specific URL you have configured.
3+
You can now configure a deployment webhook to be triggered upon successful deployments to any of your Umbraco Cloud environments. For example, when deploying from your local environment to one of your Cloud environments. Upon successful deployment, general information about the deployment will be posted in a JSON format to the specific URL you have configured.
74

85
## Use cases
96

10-
There are many use cases for deployment webhooks such as providing a detailed audit trail. Here are some scenarios where Webhooks could be useful:
7+
There are many use cases for deployment webhooks such as providing a detailed audit trail. Here are some scenarios where webhooks could be useful:
118

12-
1. Any deployments to the Live site could be relevant for many parties in a company. Posting information about a deployment in internal communication channels like _Slack_ is made possible using this feature.
13-
2. Monitoring of the whole deployment cycle. A successful deployment might cause an error to show on the website! Integrating the webhook with other monitoring services, you could find out which deployment caused the issue.
9+
1. Any deployments to the Live site could be relevant for many parties in a company. Posting information about a deployment in internal communication channels like Slack is made possible using this feature.
10+
2. Monitoring of the whole deployment cycle. A successful deployment might cause an error to show on the website. Integrating the webhook with other monitoring services, you could find out which deployment caused the issue.
1411
3. Letting content editors know about particular deployments such as when a new Document Type was added. Will inform them that they can now use the new Document Type.
1512

16-
## Configuration steps
13+
## How to set up a webhook
1714

1815
![Adding deployment webhook](images/Post-deployment-webhooks.gif)
1916

0 commit comments

Comments
 (0)