-
Notifications
You must be signed in to change notification settings - Fork 351
4221 improvements to dedicated docs #4249
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
78 commits
Select commit
Hold shift + click to select a range
429aa62
feat: added dedicated drafts
Kemi-Elizabeth e73609b
Updates contracted redirects (#4232)
gilzow b1bda5e
quotes workflow name since the name includes a comma (#4245)
gilzow 2daf6d6
Hugo build fixes: Add names/dedicated shortcode; repairs moved links;…
470d5ad
feat: made changes to draft
Kemi-Elizabeth 9d64f7d
feat: edited overview table
Kemi-Elizabeth 7b946a5
feat: made edits to page
Kemi-Elizabeth b4e5db9
feat: made more edits
Kemi-Elizabeth 723a26e
feat: added description
Kemi-Elizabeth 45c45ae
feat: updated main table
Kemi-Elizabeth 47b6c3e
Merge branch 'main' into 4221-improvements-to-dedicated-docs
chadwcarlson c790d73
Update sites/platform/src/dedicated-environments/dedicated-gen-2/envi…
Kemi-Elizabeth 4981733
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth 00a07c9
Update sites/platform/src/dedicated-environments/backups-restores.md
Kemi-Elizabeth 539f6d0
Update sites/platform/src/dedicated-environments/backups-restores.md
Kemi-Elizabeth 135daaf
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth 133029c
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth 2c6889d
Update sites/platform/src/dedicated-environments/backups-restores.md
Kemi-Elizabeth 3f08678
Update sites/platform/src/dedicated-environments/dedicated-gen-2/deve…
Kemi-Elizabeth b7aced6
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth 20817b5
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth 8bc231c
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth 83c2cf3
Update sites/platform/src/dedicated-environments/dedicated-gen-2/deve…
Kemi-Elizabeth 4266bda
Update sites/platform/src/dedicated-environments/dedicated-gen-2/deve…
Kemi-Elizabeth 51ccab0
Update sites/platform/src/dedicated-environments/dedicated-gen-2/deve…
Kemi-Elizabeth a7c2a3f
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth d544755
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth 644b65d
Update sites/platform/src/dedicated-environments/backups-restores.md
Kemi-Elizabeth f8a8de0
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth d3a9836
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth 4fefe44
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth d1d75aa
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth 7357bae
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth 2723cfa
Update sites/platform/src/dedicated-environments/dedicated-gen-2/over…
Kemi-Elizabeth 9d98db8
Update sites/platform/src/dedicated-environments/dedicated-gen-3/deve…
Kemi-Elizabeth 66cd2d4
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth 123c6a8
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth ea837ef
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth 6d077cb
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth af6928f
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth d5fe642
Update sites/platform/src/dedicated-environments/overview.md
Kemi-Elizabeth 6dd8cf5
Update sites/platform/src/dedicated-environments/overview.md
Kemi-Elizabeth 66173ed
Update sites/platform/src/dedicated-environments/overview.md
Kemi-Elizabeth 7a928bf
Update sites/platform/src/dedicated-environments/overview.md
Kemi-Elizabeth c23e11d
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth 77a62ae
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth e51f049
Update sites/platform/src/dedicated-environments/security-monitoring.md
Kemi-Elizabeth 50f7d8c
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth 5a02815
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth 7e650d3
Update overview.md
Kemi-Elizabeth fe0ae8d
Merge branch '4221-improvements-to-dedicated-docs' of https://github.…
Kemi-Elizabeth b2783e9
Update sites/platform/src/dedicated-environments/overview.md
Kemi-Elizabeth 5918b91
Update sites/platform/src/dedicated-environments/overview.md
Kemi-Elizabeth aad916a
feat: made changes
Kemi-Elizabeth 6155fd6
Merge branch '4221-improvements-to-dedicated-docs' of https://github.…
Kemi-Elizabeth 4fdd930
feat: made changes
Kemi-Elizabeth 6ff2b3d
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth 5457cba
Update sites/platform/src/dedicated-environments/dedicated-gen-3/over…
Kemi-Elizabeth 237bb5a
feat: made edits
Kemi-Elizabeth 79839c5
Merge branch '4221-improvements-to-dedicated-docs' of https://github.…
Kemi-Elizabeth 7fe420e
feat: made edits
Kemi-Elizabeth 3d50eb7
feat: made changes
Kemi-Elizabeth 5b67a30
feat: made edits
Kemi-Elizabeth beeeccf
feat: more changes
Kemi-Elizabeth 0afba11
feat: made changes
Kemi-Elizabeth 13a6328
Merge branch 'main' into 4221-improvements-to-dedicated-docs
Kemi-Elizabeth 48895f7
feat: changed shortcode
Kemi-Elizabeth ffb4811
Merge branch '4221-improvements-to-dedicated-docs' of https://github.…
Kemi-Elizabeth 6cc1493
feat: corrected broken links
Kemi-Elizabeth d5e24ad
feat: added glossary term
Kemi-Elizabeth c9fc7b3
changes static docs.platform.sh domain to {default}
gilzow 9b761b7
updates redirects associated with the change to the dedicated hosting…
gilzow 2f21fb1
updates dedicated/incident-handling anchor redirect
gilzow 037ce66
Apply suggestions from code review
chadwcarlson 34e40c2
Update sites/platform/src/dedicated-environments/backups-restores.md
chadwcarlson b31ac77
Apply suggestions from code review
chadwcarlson a61d36a
Couldn't include in batch for some reason. Update second example lead…
chadwcarlson 854f14b
Merge branch 'main' into 4221-improvements-to-dedicated-docs
chadwcarlson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: "Dedicated environments" | ||
| weight: -18 | ||
| # layout: single | ||
| description: "Our Dedicated environments provide increased resources and high availability for organizations that require higher security, better compliance, robust storage and isolated hosting." | ||
| --- |
65 changes: 65 additions & 0 deletions
65
sites/platform/src/dedicated-environments/backups-restores.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| title: "Dedicated backup and restores" | ||
| weight: 1 | ||
| sidebarTitle: "Dedicated backups" | ||
| layout: single | ||
| description: "Backups are retained for different periods depending on various factors and whether you’re using a Dedicated Gen 2 or Dedicated Gen 3 Environment. These processes can be either manual or automated." | ||
| --- | ||
|
|
||
| {{% description %}} | ||
|
|
||
|
|
||
| ## Dedicated Generation 2 Backups | ||
|
|
||
| Platform.sh takes a byte-for-byte snapshot of Dedicated Gen 2 production environments every 6 hours. Backups are retained for different durations depending on when they were taken. | ||
|
|
||
| | Backup retention period | Retention | # of backups from time period available | | ||
| |----------------|---------------------|--------------------| | ||
| | 1–3 days ago | Every backup taken in that period | 6 (1 day) to 18 (3 days) | | ||
| | 4-6 days ago | One backup per day in that period | 1 (4 days) to 3 (6 days) | | ||
| | 2–6 weeks ago | One backup per week | 1 (2 weeks) to 5 (6 weeks) | | ||
| | 8–12 weeks ago | One bi-weekly backup | 1 (8 weeks) to 3 (12 weeks) | | ||
| | 12–22 weeks ago | One backup per month | 1 (12 weeks) to 3 (22 weeks) | | ||
|
|
||
| Put another way, the number of backups available for restoration - in each of the backup age groupings described above - might look as follows for a few Dedicated environment ages: | ||
|
|
||
| | Environment age | 72 hours old or younger | 4-6 days old | 2-6 weeks old | 8-12 weeks old | 12-22 old | Total | | ||
| |----------------|---------------|--------------|----------------|-----------------|-------------------|-----| | ||
| | 1 week | 18 | 3 | 0 | 0 | 0 | 21 | | ||
| | 12 weeks | 18 | 3 | 5 | 3 | 0 | 29 | | ||
| | 52+ weeks | 18 | 3 | 5 | 3 | 3 | 32 | | ||
|
|
||
| Backups are created using snapshots saved to encrypted elastic block storage (EBS) volumes. An EBS snapshot is immediate, but the time it takes to write to the storage service depends on the volume of changes. | ||
|
|
||
| - Recovery Point Objective (RPO) is 6 hours (maximum time to last backup). | ||
| - Recovery Time Objective (RTO) depends on the size of the storage. Large EBS volumes take more time to restore. | ||
|
|
||
| These backups are only used in cases of catastrophic failure and can only be restored by Platform.sh. To request a restoration, open a [support ticket](/learn/overview/get-support.md). | ||
|
|
||
| ## Dedicated Generation 2 restoration | ||
|
|
||
| The restoration process for Dedicated Generation 2 Environments may take a few hours, depending on the infrastructure provider in use. In the ticket, specify if you want backups of files, MySQL, or both. Uploaded files are placed in an SSH-accessible directory on the Dedicated Gen 2 cluster. | ||
|
|
||
| MySQL is provided as a MySQL dump file on the server. You may restore these to your site at your leisure. You are also free to make your own backups using standard tools (mysqldump, rsync, etc.). | ||
|
|
||
| {{< note title="Note" theme="info" >}} | ||
|
|
||
| Platform.sh does not proactively overwrite your production site with a backup. You are responsible for determining a “safe” time to restore the backup, or for selectively restoring individual files if desired. | ||
|
|
||
| {{< /note >}} | ||
|
|
||
| ## Dedicated Generation 3 | ||
|
|
||
| For Dedicated Generation 3 Environments, [automated backups](environments/backup.md#use-automated-backups) are retained for a specific amount of time depending on their type and your [backup schedule](/environments/backup.md#backup-schedule). [Manual backups](/environments/backup.md#create-a-manual-backup) are retained until you delete them or replace them with another backup. | ||
|
|
||
| |Type |Basic |Advanced |Premium | | ||
| |----------------|---------------------|-----------------|-----------| | ||
| | 6-hourly | - | - |1 day | | ||
| | Daily | 2 days | 1 week |1 month | | ||
| | Weekly | - | 4 weeks |- | | ||
| | Monthly | - | 1 year |1 year | | ||
|
|
||
|
|
||
| ## Dedication Generation 3 restores | ||
|
|
||
| Dedicated Generation 3 Environments allow for backups and restores the same way as Grid, so you can use them with the management console and the [Platform.sh CLI](/administration/cli/_index.md). |
2 changes: 1 addition & 1 deletion
2
sites/platform/src/dedicated-gen-2/_index.md → ...ed-environments/dedicated-gen-2/_index.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: "{{% names/dedicated-gen-2 %}}" | ||
| weight: -18 | ||
| weight: -19 | ||
| description: "{{% names/dedicated-gen-2 %}} is a robust, redundant layer. This section contains all resources concerning the {{% names/dedicated-gen-2 %}} product." | ||
| --- |
78 changes: 78 additions & 0 deletions
78
sites/platform/src/dedicated-environments/dedicated-gen-2/development.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| title: "Dedicated Gen 2 Development" | ||
| weight: 1 | ||
| sidebarTitle: "DG2 development" | ||
| description: "Learn about the cluster infrastructure of Dedicated Generation 2, and discover key details about split architecture, deployment, storage limits and memory." | ||
|
|
||
| --- | ||
|
|
||
| Learn about the [cluster infrastructure](#cluster-infrastructure) of Dedicated Generation 2, and discover key details about [split architecture](#split-architecture), [deployment](#deployment), [storage limits](#storage) and [memory](#memory). | ||
|
|
||
| ### Cluster infrastructure | ||
|
|
||
| Dedicated Gen 2 clusters (sometimes referred to below as DG2) are launched into a Triple Redundant configuration consisting of 3 hosts. This is an N+1 configuration that’s sized to withstand the total loss of any one of the 3 members of the cluster without incurring any downtime. Every service is replicated across all three hosts in a failover configuration (as opposed to sharding), allowing a site to remain up even if one of the hosts is lost entirely. | ||
|
|
||
| Each instance hosts the entire application stack, allowing this architecture superior fault tolerance to traditional N-Tier installations. Moreover, the Cores assigned to production are solely for production. | ||
|
|
||
| ##### Build process | ||
|
|
||
| The build process for your application is identical for both the Grid Environment and the Dedicated Gen 2 cluster. However, because the hosts are provisioned by Platform.sh, not as a container, service configuration must be done by Platform.sh’s Customer Success team. The flexibility for DG2 and Grid can be made to be the same but only via opening a [support ticket](/learn/overview/get-support.md). | ||
|
|
||
| For more information, learn about [default storage settings](#storage) and how your app can [connect to services](dedicated-environments/dedicated-gen-3/overview.md#available-services). | ||
|
|
||
| ### Split architecture | ||
|
|
||
| Split architecture works under Dedicated Generation 2 and allows to give more resources globally to a project. Services (data services, caching service or search engines) are split from application runtimes. Services will be running on a cluster of core nodes, and the application will be running on a cluster of web nodes. | ||
|
|
||
| This allows us to grant more room for the application or the services regarding resources. Both clusters can differ in size. Split architecture clusters can horizontally scale the application by adding additional nodes. | ||
|
|
||
|  | ||
|
|
||
| ### Deployment | ||
|
|
||
| The production branch of your Git repository is designated for production and a staging branch is designated for staging. Any code merged to those branches automatically triggers a rebuild of the production or staging environment in the Dedicated Gen 2 cluster. | ||
|
|
||
| Any defined users or environment variables are also propagated to the Dedicated Gen 2 cluster. | ||
|
|
||
| {{< note title="Note" theme="info" >}} | ||
|
|
||
| There is no automatic cloning of data from the Dedicated Gen 2 cluster to the development environment the way there is between branches in the development environment. | ||
|
|
||
| {{< /note >}} | ||
|
|
||
| Production data may still be replicated to the development environment [manually](https://docs.platform.sh/administration/cli/reference.html#environmentsynchronize). Deployments of other branches don’t trigger rebuilds of the Dedicated Gen 2 cluster Environments. | ||
|
|
||
| #### Deployment process | ||
|
|
||
| When deploying to the Dedicated Gen 2 cluster the process is slightly different than when working with Platform.sh on the Grid. | ||
|
|
||
| - The new application image is built in the exact same fashion as for the Grid. | ||
| - Any active background tasks on the cluster, including cron tasks, are terminated. | ||
| - The cluster (production or staging) is closed, meaning it doesn’t accept new requests. Incoming requests receive an HTTP 500 error. | ||
| - The application image on all three servers is replaced with the new image. | ||
| - The deploy hook is run on one, and only one, of the three servers. | ||
| - The cluster is opened to allow new requests. | ||
|
|
||
| The deploy usually takes approximately 30-90 seconds, although that is dependent on how your deploy hook has been configured. | ||
|
|
||
| During the deploy process the cluster is unavailable. All Dedicated Gen 2 instances are fronted by the Fastly Content Delivery Network (CDN) unless you decide to bring your own CDN. You can also decide that you'd rather not use Fastly. Fastly can be configured to allow a “grace period”, meaning that requests to the origin that fail are served from the existing cache, even if that cache item is stale. We configure a default grace period that is longer than a typical deployment, and can extend that time upon request. That means anonymous users should see no interruption in service at all. Authenticated traffic that can’t be served by the CDN still sees a brief interruption. | ||
|
|
||
| For more information about deployment, see the [overview of the build and deploy phases](/learn/overview/build-deploy.md). | ||
|
|
||
| ### Storage | ||
chadwcarlson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The development environment for a Dedicated Gen 2 project provides production and staging branches linked to the Dedicated Gen 2 cluster and 3 additional active environments for development. This number can be increased if needed for an [additional fee](https://platform.sh/pricing/). | ||
|
|
||
| The default storage for Dedicated Gen 2 contracts is 50GB per environment (production, staging, and each development environment). This comprises total storage for your project and is inclusive of any databases, uploaded files, writable application logging directories, search index cores, and so on. The storage amount for your development environment reflects the amount in your Enterprise contract and can be altered based on the terms you agree. | ||
|
|
||
| A project may have up to six users associated with it at no additional charge. Additional users may be added for an additional fee. These users have access to both the development environment and the Dedicated Gen 2 cluster. | ||
|
|
||
| {{< note title="Note" theme="info" >}} | ||
|
|
||
| While your DG2 production and staging Environments are on dedicated virtual machines, your development environments run on the [Grid](/glossary.md#grid). This means that, by default, all containers in development environments are standard sized, as they have limited traffic needs. For more resource-intensive applications this size can be increased for an additional fee. | ||
|
|
||
| {{< /note >}} | ||
|
|
||
| ### Memory | ||
|
|
||
| Dedicated Generation 2 includes a single node dedicated staging with 2 CPUs. This runs the same software configuration as the production cluster but only on a single node. This is usually enough for functional testing before moving to production. You can choose to upgrade your staging to a more powerful machine or add more than one dedicated staging system. Those will still be a single machine. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.