Skip to content

Commit

Permalink
Merge pull request #3749 from platformsh/upsun-migrate-environments
Browse files Browse the repository at this point in the history 
[Upsun migration] Environments section
  • Loading branch information
@chadwcarlson
chadwcarlson committed Feb 12, 2024
2 parents 8f3ef5b + cad443d commit 1555918
Show file tree
Hide file tree
Showing 12 changed files with 1,120 additions and 52 deletions.
8 changes: 4 additions & 4 deletions sites/friday/config/_default/config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ module:
- source: "../platform/src"
target: "content"
excludeFiles:

# - "add-services/*"
- "add-services/network-storage.md"

Expand All @@ -70,7 +70,7 @@ module:
- "create-apps/flexible-resources.md"

- "dedicated-gen-2/*"

- "dedicated-gen-3/*"

# - "define-routes/*"
Expand All @@ -88,8 +88,8 @@ module:
- "domains/security/web-application-firewall/fastly.md"
- "domains/steps/custom-domains-preview-environments.md"

# - "environments/*"
- "environments/scalability.md"
- "environments/*"
#- "environments/scalability.md"

# - "feedback/*"

Expand Down
290 changes: 290 additions & 0 deletions sites/friday/src/environments/_index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,290 @@
---
title: "Manage {{% vendor/name %}} environments"
weight: -75
layout: single
sidebarTitle: Manage environments
description: Learn what environments on {{% vendor/name %}} are and how to take advantage of them.
keywords:
- Git push options
- git push options
---

A {{% vendor/name %}} environment contains one instance of an app (or [group of apps](../create-apps/multi-app/_index.md))
with all the services needed for it to run.

Each project can include multiple environments,
often divided into [environment types](../administration/users.md#environment-type-roles).
If you have a live site, you have at least a production environment.
You can think of other environments as copies of your live site
where you can run tests without worrying about damaging anything in production.
Once you have completed your tests,
you can merge your changes so that they're instantly and seamlessly deployed to production.

You can create environments for development, testing, staging, review, and so on.
To organize your environments, you can create [hierarchical relationships](#hierarchy).

## Create environments

You can create new environments in one of two ways:

- Push a local branch through Git or a [source integration](../integrations/source/_index.md).

- [Branch](/glossary.md#branch) existing environments using the [CLI](/administration/cli/_index.md)
or the [Console](../administration/web/_index.md).

When you branch an environment, you might want to create exact replicas of it.
In this case, each new environment inherits all of the data and services from its parent environment.
This includes databases, network storage, queues, and routing configurations.

You can create {{% vendor/name %}} environments on demand.
Each environment is tied to a Git branch.
If you use a source integration,
you can even have environments created automatically for your pull requests and branches.

You can also have branches that aren't tied to a running instance of your application.
These are called [inactive environments](#environment-status).

## Default environment

Your default environment comes from your default branch and is a [production environment](../administration/users.md#environment-type-roles).
Your project must have a default environment,
but you can [name it as you want](./default-environment.md).

If you subscribed to a production plan, this environment is your **live site**.
You might want to give it a [custom domain name](../domains/steps/_index.md).

## Environment status

Your environments can have one of two statuses:

- [Active](/glossary.md#active-environment):
A deployed environment with services and data.

- [Inactive](/glossary.md#inactive-environment):
An environment that isn't deployed and has no services or data, only code.

You can see the status of your environments in the [Console](../administration/web/_index.md) or the [CLI](/administration/cli/_index.md).

{{< codetabs >}}
+++
title=In the Console
+++

When you open your project, inactive environments appear lighter in the environment list.
You also can't select them from the **Environment** dropdown menu.

To check the status of an environment,
you can also open it and view its information panel.

<--->
+++
title=Using the CLI
+++

To check the status of all your environments, from your project directory run the `{{% vendor/cli %}} environments` command.

{{< /codetabs >}}

You can [change an environment's status](./deactivate-environment.md) at any time.

## Organize your environments

### Hierarchy

![Environment hierarchy](/images/management-console/environments.png "0.5")

In {{% vendor/name %}}, your environments are organized in a hierarchy featuring parent and child environments.

When you [branch](/glossary.md#branch) an environment,
the parent of the new environment is the environment it was created from.
You can [change the environment's parent](./change-parent.md) after it's been created.

When you push a branch through Git or a [source integration](../integrations/source/_index.md),
the parent environment of the new environment is your [default environment](#default-environment).
Alternatively, you can [change the environment's parent](./change-parent.md) after it's been created.

Each child environment can [sync](/glossary.md#sync) code and/or data down from its parent
and [merge](/glossary.md#merge) code up to its parent.
You can use child environments for development, staging, and testing.

### Workflows

Since you can customize your [environment hierarchy](#hierarchy), you can create your own workflows.
You can decide which structure best fits your needs.

#### Possible approaches

You may want to take one of the following approaches when creating your workflows:

- **Agile**: A child environment per sprint.
Each story in the sprint can have its own environment as a child of the sprint environment.

- **Developer-centric**: One QA environment and a few preview environments
(*per developer*, *per task*, or similar).

- **Testing**: An operational test environment, a user test environment, and a few unit test environments.

- **Hotfix**: One environment for each bug, security issue, or hotfix that needs deployment.

#### Example workflow

Example Agile workflow:

1. An admin [branches](/glossary.md#branch) the Live (default) environment to create a Sprint environment.

2. The admin gives each developer permission to branch the Sprint environment to create new feature environments.

![Agile branches with Live as the top parent, Sprint 1 as a child, and Feature 1 and Feature 2 as children of Sprint](/images/workflow/branches.svg "0.2")

3. Feature 1 is developed and work is reviewed by accessing the deployed Feature 1 environment.

4. When the review is done, Feature 1 is [merged](/glossary.md#merge) into the Sprint environment.

![Feature 1 is merged into the Sprint 1 environment](/images/workflow/merge-feature.svg "0.25")

5. The remaining features [sync](/glossary.md#sync) with the Sprint environment.
This ensures their working environment is up-to-date with the latest code.

![Features from the Sprint 1 environment are synced with the Feature 2 environment](/images/workflow/sync.svg "0.25")

6. When the sprint is complete and all features merged into the Sprint environment,
the admin makes a backup of the live site.

7. The admin merges the Sprint environment into the Live environment.

![Features from the Sprint 1 environment are merged into the Live environment](/images/workflow/merge-live.svg "0.2")

8. The admin syncs the next sprint's environment with the Live environment
to repeat and continue the development process.

![Features from the Live environment are synced with the Sprint 2 environment](/images/workflow/sync-live.svg "0.2")

### Naming conventions

You can organize and work with your preview environments in many different ways.
It can help to introduce a convention for how you name and structure your environments.

For each environment, choose a name that represents what the environment is for.
If you use Agile, for example, you can adopt a naming convention similar to the following:

```text
Live
Sprint1
Feature1
Feature2
Feature3
Sprint2
Feature1
Feature2
```

If you prefer splitting your environments per developer and having a specific environment for each task or ticket,
you can adopt a naming convention similar to the following:

```text
Staging
Developer1
Ticket-526
Ticket-593
Developer2
Ticket-395
```

## Paused environments

[Preview environments](/glossary.md#preview-environment) are often used for a limited time and then abandoned.
To prevent unnecessary consumption of resources,
{{% vendor/name %}} automatically pauses preview environments ([of both development and staging types](/glossary.md#environment-type)) that haven't been redeployed in 14 days.

You can also pause an environment manually at any time.

### Pause an environment

To pause an environment, follow these steps:

{{< codetabs >}}

+++
title=Using the CLI
+++

Run the following command:

```bash
{{% vendor/cli %}} environment:pause --project {{< variable "PROJECT_ID" >}} --environment {{< variable "ENVIRONMENT_NAME" >}}
```

<--->
+++
title=In the Console
+++

1. Navigate to your project and click {{< icon settings >}} **Settings**.
2. Under **Environments**, select the environment you want to pause.
3. In the **Status** tab, click **Pause environment**.

{{< /codetabs >}}

### Resume a paused environment

Pushing new code or redeploying a paused environment automatically resumes it.
You can also resume it manually at any time.

{{< codetabs >}}

+++
title=Using the CLI
+++

Run the following command:

```bash
{{% vendor/cli %}} environment:resume --project {{< variable "PROJECT_ID" >}} --environment {{< variable "ENVIRONMENT_NAME" >}}
```

<--->
+++
title=In the Console
+++

1. Navigate to the paused environment.
2. In the Activity tab, click **Resume environment**.
3. In the **Resume environment** window, click **Resume**.

{{< /codetabs >}}

The environment is redeployed and becomes available for use again.

## Push options

Git provides push options to pass a string to the server (see [the official Git documentation](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt)).

{{% vendor/name %}} supports some of these push options,
which allows you to push changes to your environment and trigger the following actions at the same time:

| Action | Command |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| Activate the environment | `git push {{% vendor/cli %}} -o "environment.status=active"` |
| Set a title for the environment | `git push {{% vendor/cli %}} -o "environment.title=<ENVIRONMENT_TITLE>"` |
| Set the parent environment | `git push {{% vendor/cli %}} -o "environment.parent=<PARENT_ENVIRONMENT_NAME>"` |
| Clone the data from the parent environment | `git push {{% vendor/cli %}} -o "environment.clone_parent_on_create=True"` |
| Disable the cloning of the data from the parent environment | `git push {{% vendor/cli %}} -o "environment.clone_parent_on_create=False"` |
| Set the environment type (`development`, `staging`, or `production`) | `git push {{% vendor/cli %}} -o "environment.type=<ENVIRONMENT_TYPE>"` |
| Define a [resource initialization strategy](/manage-resources/_index.md#define-a-resource-initialization-strategy) (`Default`, `Manual`, `Minimum`, or `Parent`) | `git push {{% vendor/cli %}} -o "resources.init=<RESOURCE_INITIALIZATION_STRATEGY>"` |

If your remote location isn't named `{{% vendor/cli %}}`,
make sure you adjust the commands accordingly.

{{< note >}}

You can't use push options if you have a [source integration](/integrations/source/_index.md) set up.

{{< /note >}}

The following example shows how, through a single `push`,
you can activate your environment, set a title for it,
set a parent environment for it, and clone the data from its parent into it.

```bash {location="Terminal"}
git push {{% vendor/cli %}} -o "environment.status=active" -o "environment.title=my-environment-title" -o "environment.parent=my-parent-environment" -o "environment.clone_parent_on_create=True"
```
Loading

0 comments on commit 1555918

Please sign in to comment.