Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Removing deprecated AWS EC2 with Terraform and Digital Ocean App Platform V1 deployments #255

Merged
merged 5 commits into from
Sep 14, 2023
Merged

Removing deprecated AWS EC2 with Terraform and Digital Ocean App Platform V1 deployments #255

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08e64f5
removing files and updating readme
scottisloud Sep 14, 2023
41a81cc
Adding links to deletion PR
scottisloud Sep 14, 2023
f0d957b
fixing note callout
scottisloud Sep 14, 2023
79feaab
fixing style guide deviation
scottisloud Sep 14, 2023
887a5a7
Fixing grammar gaff
scottisloud Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions deprecated/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,30 @@

This folder contains 1Password SCIM Bridge deployment methods that have been deprecated. At the time of deprecation, these deployments are still fully functional, but will no longer be updated.

> 💡 **Note** that it is solely the _deployment method_ that is deprecated. Deprecating a deployment method is independent of the 1Password SCIM Bridge itself, or a specific version of the 1Password SCIM Bridge. For information about the latest version of 1Password SCIM Bridge, please see the [changelog](https://app-updates.agilebits.com/product_history/SCIM).
> **Note**
> that it is solely the _deployment method_ that is deprecated. Deprecating a deployment method is independent of the 1Password SCIM Bridge itself, or a specific version of the 1Password SCIM Bridge. For information about the latest version of 1Password SCIM Bridge, please see the [changelog](https://app-updates.agilebits.com/product_history/SCIM).
scottisloud marked this conversation as resolved.
Show resolved Hide resolved
scottisloud marked this conversation as resolved.
Show resolved Hide resolved

## Deprecated deployment method list

The following deployment methods are deprecated and will be removed from the repository on or around the Deletion Date.

| Deployment | Deprecation Date | Deletion Date | Suggested Alternative | Deprecation PR |
| --------------------------------------------------------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- |
| [aws-ec2-terraform](./aws-terraform) | 2020-12-21 | 2023-09-14 | [AWS ECS Fargate with Terraform](../aws-ecsfargate-terraform/) or [AWS ECS Fargate with CloudFormation](../beta/aws-ecsfargate-cfn/) | [PR#127](https://github.com/1Password/scim-examples/pull/127) |
| [DigitalOcean App Platform](./digitalocean-app-platform/) | 2022-12-21 | 2023-09-14 | [Digital Ocean App Platform with `op` CLI](../beta/do-app-platform-op-cli/) or [Azure Container Apps](../beta/azure-container-apps/) | [PR#222](https://github.com/1Password/scim-examples/pull/222) |
| Deployment | Deprecation Date | Deletion Date | Suggested Alternative | Deprecation PR |
| ---------- | ---------------- | ------------- | --------------------- | -------------- |
| - | - | - | - | - |
| - | - | - | - | - |

### Deleted deployment methods

The following is a list of deployment methods that are no longer supported and were removed from the repository upon expiration of their deperecation period. These deployment methods are no longer supported. If you previously depended on one of these deployment methods, consider one of the suggested alternatives.

| Deployment | Deprecation Date | Deletion Date | Suggested Alternative | Deprecation and Deletion PRs |
| ---------- | ---------------- | ------------- | --------------------- | ---------------------------- |
| - | - | - | - | - |
| Deployment | Deprecation Date | Deletion Date | Suggested Alternative | Deprecation and Deletion PRs |
| ------------------------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| aws-ec2-terraform | 2020-12-21 | 2023-09-14 | [AWS ECS Fargate with Terraform](../aws-ecsfargate-terraform/) or [AWS ECS Fargate with CloudFormation](../beta/aws-ecsfargate-cfn/) | Dep: [PR#127](https://github.com/1Password/scim-examples/pull/127) \| Del: [PR#255](https://github.com/1Password/scim-examples/pull/255) |
| DigitalOcean App Platform | 2022-12-21 | 2023-09-14 | [Digital Ocean App Platform with `op` CLI](../beta/do-app-platform-op-cli/) or [Azure Container Apps](../beta/azure-container-apps/) | Dep: [PR#222](https://github.com/1Password/scim-examples/pull/222) \| Del: [PR#255](https://github.com/1Password/scim-examples/pull/255) |

## Process for deprecating deployment methods

Generally speaking we try to improve existing deployment methods or create additional deployment methods. However, sometimes deployment methods become no longer relevant and so may be deprecated.
Generally speaking we try to improve existing deployment methods or create additional deployment methods. However, sometimes deployment methods become no longer relevant and so may be deprecated.

Common reasons a deployment method may be deprecated include one or more of:

Expand All @@ -35,15 +37,15 @@ Common reasons a deployment method may be deprecated include one or more of:
All deprecations will take place through a pull request and must be approved by a 1Password employee.

1. Identify a candidate for deprecation using the [above criteria](#process-for-deprecating-deployment-methods) along with insights from Integrations Support, your experience, and changes to dependencies, required utilities, host platforms, and technologies.
- There are no hard and fast rules here, and no single criteria. When making deprecation decisions, the focus should be on ensuring the best possible experience for 1Password SCIM Bridge users. This does not immediately imply we maintain everything forever. To produce the best possible experience may require removing non-relevant deployment methods to enable us to focus on more relevant deployment methods.
- There are no hard and fast rules here, and no single criteria. When making deprecation decisions, the focus should be on ensuring the best possible experience for 1Password SCIM Bridge users. This does not immediately imply we maintain everything forever. To produce the best possible experience may require removing non-relevant deployment methods to enable us to focus on more relevant deployment methods.
2. Open a new branch with a name conforming to `deprecate/<deployment-method-name>`
3. Move all assets related to the deployment method to `./deprecated/<deployment-method-name>`
4. Update READMEs
- To the [Deprecated Deployments table](README.md#deprecated-deployment-method-list) in `deprecated/README.md`:
- Add the name and link to the updated path of the deployment in `/deprecated`
- Set `Deprecation Date` to be the current date (to be updated at merge time to the date of the merge)
- Set `Deletion Date` to be approximately three months from the deprecation date (considering weekends, holidays, or other events). This may or may not be updated along with the deprecation date at merge time.
- Add link to PR, once known, to the `Deprecation PR` column.
- Add link to PR, once known, to the `Deprecation PR` column.
- To the [README in the repository root](../README.md) add:
- Prefix the name of the deployment in the list with `**(⚠️ Deprecated)**`.
- Update the URL of the linked text point to the new path of the deployment in `/deprecated`.
Expand All @@ -62,6 +64,6 @@ Deleting a deprecated deployment that has reached it's Deletion Date will take p
3. Updated READMEs
- Remove the deployment method from the [Deprecated deployment method table](README.md#deprecated-deployment-method-list) in `deprecated/README.md`
- Add the deployment to the [Deleted deployment methods](README.md#deleted-deployment-methods) table.
- Add link to the PRs used for the original deprecation, and for deletion (once known), to the appropriate column in table.
- Add link to the PRs used for the original deprecation, and for deletion (once known), to the appropriate column in table.
- Remove the deployment method from [README in the repository root](../README.md)
4. Put your PR up for review and approval.
124 changes: 0 additions & 124 deletions deprecated/aws-terraform/README.md
View file
Open in desktop

This file was deleted.

64 changes: 0 additions & 64 deletions deprecated/aws-terraform/apt.agilebits.com_repo_key.asc
View file
Open in desktop

This file was deleted.

Loading