From 294ddcf04b090ca682e8068f8f316998ef404971 Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 08:32:03 -0600 Subject: [PATCH 1/8] feat: Add the new organization roles to the docs --- admin/access-control/organizations.md | 392 +++++++++++++++++++++++++- 1 file changed, 391 insertions(+), 1 deletion(-) diff --git a/admin/access-control/organizations.md b/admin/access-control/organizations.md index 95ac5853d..4d6a25b14 100644 --- a/admin/access-control/organizations.md +++ b/admin/access-control/organizations.md @@ -35,7 +35,7 @@ Please note that roles are defined per organization. Therefore, assigning someone as an organization manager does not change their role in another organization. -### Organization manager permissions +### Organization super manager permissions @@ -165,6 +165,396 @@ organization.
+### Organization manager permissions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CreateRead (all)Read (own)ListDelete (all)Delete (own)Update (all)Update (own)
Dev URLsX
WorkspacesXXXXXX
ImagesXXXX
Image tagsXXXX
MetricsXX
Org membersX
OrgsXX
RegistriesXXXX
System bannersX
UsersXX
+ +### Organization image manager permissions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CreateRead (all)Read (own)ListDelete (all)Delete (own)Update (all)Update (own)
Dev URLsX
WorkspacesXXXX
ImagesXXXX
Image tagsXXXX
MetricsX
Org membersX
OrgsX
RegistriesX
System bannersX
UsersX
+ +### Organization importer permissions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CreateRead (all)Read (own)ListDelete (all)Delete (own)Update (all)Update (own)
Dev URLsX
WorkspacesXXXX
ImagesXX
Image tagsXX
MetricsX
Org membersX
OrgsX
RegistriesX
System bannersX
UsersX
+ ### Organization member permissions From 5e19053a5bc3289fb96d954549a62b2cc546fc13 Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 08:46:23 -0600 Subject: [PATCH 2/8] Add new roles to summaries --- admin/access-control/organizations.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/admin/access-control/organizations.md b/admin/access-control/organizations.md index 4d6a25b14..1efb7ed47 100644 --- a/admin/access-control/organizations.md +++ b/admin/access-control/organizations.md @@ -4,7 +4,7 @@ description: Learn how to manage organization roles. --- You can assign members of an [organization](../organizations.md) roles, which -function like [user roles](users/user-roles.md). There are two roles available: +function like [user roles](users/user-roles.md). There are five roles available:
@@ -15,17 +15,31 @@ function like [user roles](users/user-roles.md). There are two roles available: - + + + + + + + + + + + + + From b4aec9101fe9aa44d508c4d85764aed848f488bc Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 08:54:13 -0600 Subject: [PATCH 3/8] Lowercase a word --- admin/access-control/organizations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/access-control/organizations.md b/admin/access-control/organizations.md index 1efb7ed47..bd44c7fac 100644 --- a/admin/access-control/organizations.md +++ b/admin/access-control/organizations.md @@ -33,7 +33,7 @@ function like [user roles](users/user-roles.md). There are five roles available: - From 2003bdfba4dbe6b1606341deb573a4eaa65e4370 Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 08:58:36 -0600 Subject: [PATCH 4/8] Org members cannot create images --- admin/access-control/organizations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/admin/access-control/organizations.md b/admin/access-control/organizations.md index bd44c7fac..a9ae9b197 100644 --- a/admin/access-control/organizations.md +++ b/admin/access-control/organizations.md @@ -610,7 +610,7 @@ organization. - + @@ -621,7 +621,7 @@ organization. - + From 1307c78d8a90fd435ec886ed511bc65f95f9c05c Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 09:00:10 -0600 Subject: [PATCH 5/8] Update manager workspace row --- admin/access-control/organizations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/admin/access-control/organizations.md b/admin/access-control/organizations.md index a9ae9b197..53e94de2a 100644 --- a/admin/access-control/organizations.md +++ b/admin/access-control/organizations.md @@ -213,9 +213,9 @@ organization. + - - + From f84b1951e8acf6a5f2a328dd0912dbf342fb73e8 Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 09:02:39 -0600 Subject: [PATCH 6/8] Move readall workspaces to readown --- admin/access-control/organizations.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/admin/access-control/organizations.md b/admin/access-control/organizations.md index 53e94de2a..16a372dec 100644 --- a/admin/access-control/organizations.md +++ b/admin/access-control/organizations.md @@ -81,7 +81,7 @@ organization. - + @@ -211,7 +211,7 @@ organization. - + @@ -340,8 +340,8 @@ organization. - + @@ -470,8 +470,8 @@ organization. - + @@ -600,8 +600,8 @@ organization. - + From 7f3849a51f763b419285ec485d6df6da43256a69 Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 09:20:06 -0600 Subject: [PATCH 7/8] Fix linting issues --- guides/moving-to-oss.md | 40 +++++++++++++------------- guides/v2-faq.md | 63 ++++++++++++++++++++--------------------- index.md | 11 ++++--- 3 files changed, 57 insertions(+), 57 deletions(-) diff --git a/guides/moving-to-oss.md b/guides/moving-to-oss.md index 4159e8fc7..0534fe311 100644 --- a/guides/moving-to-oss.md +++ b/guides/moving-to-oss.md @@ -3,8 +3,9 @@ title: "Moving to Coder v2" description: What you need to know about Coder v2 --- -Coder v2 is Coder's open core remote development platform first launched in June -2022. Coder v2 has an [open-source](https://github.com/coder/coder) "OSS" and an +Coder v2 is Coder's open core remote development platform first launched in +June 2022. Coder v2 has an [open-source](https://github.com/coder/coder) "OSS" +and an [Enterprise paid edition](https://coder.com/docs/coder-oss/latest/enterprise). This document shares best practices for moving your workflows from Coder v1 to Coder v2. @@ -36,8 +37,8 @@ comparison table before you proceed. ## Migration Strategy -A separate control plane is necessary to run Coder v2. A direct upgrade via -Helm is not possible since Coder v2 redefines some concepts (e.g. templates, +A separate control plane is necessary to run Coder v2. A direct upgrade via Helm +is not possible since Coder v2 redefines some concepts (e.g. templates, provisioners) and other features are still being developed (e.g. audit log, organization support). @@ -83,7 +84,6 @@ database and a reverse proxy for TLS. | **Multi region/cloud (workspaces)** | ✅ [Workspace providers](https://coder.com/docs/coder/latest/admin/workspace-providers) support additional clusters. | ✅ [Templates](https://coder.com/docs/coder/latest/admin/templates) can provision resources in any clouds, clusters, or region | | **Multi region/cloud (tunnel/SSH)** | ✅ | ✅ | - ### CLI Coder v2 uses a separate @@ -119,8 +119,7 @@ authentication. | Generated SSH key | ✅ | ✅ | | Default shell | ✅ | Per-workspace [(with parameters)](https://coder.com/docs/coder-oss/latest/templates#parameters) | | Auto-start times | ✅ | Per-workspace | -| Git OAuth | ✅ | ✅ | - +| Git OAuth | ✅ | ✅ | User-wide settings (e.g. shell, autostart times, dotfiles URL) are not currently supported in Coder v2 [(#3506)](https://github.com/coder/coder/issues/3506). @@ -182,7 +181,6 @@ comparison: | **Resource provisoning rates** | ✅ Organization wide | ✅ Template wide [(needs docs)](https://github.com/coder/coder/issues/3519) | | **Manage workspaces through UI and CLI** | ✅ | ✅ | - ### Developer experience Some developer experience features are different, or still being worked on in @@ -204,21 +202,21 @@ Coder v2. Refer to this table: | **Manage workspaces through UI and CLI** | ✅ | ✅ | | **Open in Coder button** | ✅ | 🤔 [(needs docs)](https://github.com/coder/coder/issues/3981) | - ### Enterprise/management Some enterprise features are different, or still being worked on in Coder v2. Refer to this table: -| | Coder v1 | Coder v2 | -| ------------------------------------ | ----------------- | ------------------------------------------------------------------------------------------- | -| **Auto-stop workspace** | ✅ Activity-based | ✅ Schedule-based & ✅ Activity-based ) | -| **Audit logging** | ✅ | ✅ | -| **Organizations** | ✅ | ✅ Groups & template permissions | -| **Workspace Proccess Logging** | ✅ | ⌛ [#5314](https://github.com/coder/coder/issues/5314) | -| **User metrics** | ✅ | Template-wide metrics [(needs docs)](https://github.com/coder/coder/issues/3980) | -| **Resource quotas** | ✅ | ✅ Max workspace limit | -| **SDK** | ❌ | ✅ [codersdk](https://github.com/coder/coder/tree/main/codersdk) | -| **REST API** | ✅ | ✅ | - -> See the [v1 sunset frequently asked questions](./v2-faq.md) for more information. +| | Coder v1 | Coder v2 | +| ------------------------------ | ----------------- | -------------------------------------------------------------------------------- | +| **Auto-stop workspace** | ✅ Activity-based | ✅ Schedule-based & ✅ Activity-based ) | +| **Audit logging** | ✅ | ✅ | +| **Organizations** | ✅ | ✅ Groups & template permissions | +| **Workspace Proccess Logging** | ✅ | ⌛ [#5314](https://github.com/coder/coder/issues/5314) | +| **User metrics** | ✅ | Template-wide metrics [(needs docs)](https://github.com/coder/coder/issues/3980) | +| **Resource quotas** | ✅ | ✅ Max workspace limit | +| **SDK** | ❌ | ✅ [codersdk](https://github.com/coder/coder/tree/main/codersdk) | +| **REST API** | ✅ | ✅ | + +> See the [v1 sunset frequently asked questions](./v2-faq.md) for more +> information. diff --git a/guides/v2-faq.md b/guides/v2-faq.md index 6b549814b..d6080b6c5 100644 --- a/guides/v2-faq.md +++ b/guides/v2-faq.md @@ -1,6 +1,7 @@ --- title: "Sunsetting Coder v1 and v2 Migration FAQ" -description: Frequently asked questions about sunsetting of Coder v1 and migrating to v2 +description: + Frequently asked questions about sunsetting of Coder v1 and migrating to v2 --- [Coder v2](https://github.com/coder/coder) is Coder's 2nd generation remote @@ -14,19 +15,19 @@ questions for customers planning to migrate from Coder v1 to v2. Coder v1 will have 3 sunset or end-of-life dates. -| Date | Support Sunset Parameters | Example | -| --------------- | ------------------------------------------------------------ | ---------------------------------------------- | -| 06/30/2023 | End of feature requests and enhancements | image tag decommissioning coming in `1.38.0` | -| 12/31/2023 | End of feature-related bug fixes | [organization sort order](../changelog/1.37.0.md) in `1.37.0` | -| 03/31/2024 | End of security vulnerability fixes | malicious [DevURL redirect link fix](../changelog/1.37.1.md) in `1.37.1` | +| Date | Support Sunset Parameters | Example | +| ---------- | ---------------------------------------- | ------------------------------------------------------------------------ | +| 06/30/2023 | End of feature requests and enhancements | image tag decommissioning coming in `1.38.0` | +| 12/31/2023 | End of feature-related bug fixes | [organization sort order](../changelog/1.37.0.md) in `1.37.0` | +| 03/31/2024 | End of security vulnerability fixes | malicious [DevURL redirect link fix](../changelog/1.37.1.md) in `1.37.1` |
How will we continue to get v1 support? -Continue to either coordinate with your Coder account executive or leverage -the [Slack](https://cdr.co/join-community) channel. +Continue to either coordinate with your Coder account executive or leverage the +[Slack](https://cdr.co/join-community) channel.
@@ -37,9 +38,8 @@ Coder v2 addresses compute and integration limitations of Coder v1. In particular, 100% control over a workspace's Kubernetes pod spec, flexibility to make workspace compute a Kubernetes pod, a VM, or a Docker container, and an open-source platform for the community to get the developer-centric benefits of -remote development without a license fee. See the blog post [Lessons learned -from -v1](https://coder.com/blog/lessons-learned-from-v1-and-oss-to-enterprise-editions). +remote development without a license fee. See the blog post +[Lessons learned from v1](https://coder.com/blog/lessons-learned-from-v1-and-oss-to-enterprise-editions). @@ -47,9 +47,9 @@ v1](https://coder.com/blog/lessons-learned-from-v1-and-oss-to-enterprise-edition What Coder v2 features are open-source and paid? Functionality for a developer to be productive are in the v2 OSS, while -scalability, governance and control features for DevOps teams are in the -v2 Enterprise paid version. [See this page for feature -comparisons.](https://coder.com/pricing) +scalability, governance and control features for DevOps teams are in the v2 +Enterprise paid version. +[See this page for feature comparisons.](https://coder.com/pricing) @@ -73,17 +73,17 @@ platform into a new code base. v2 also has a different Postgres database schema.
How are the v2 concepts different than v1 at a high-level? -In v1, workspaces are Kubernetes pods with an inner container based on [container -images](../images/index.md) with an optional configure script in the image that runs additional -configurations as the non-root user after the workspace is built. Coder v1 has an -optional workspace template yaml spec to define compute and additional bash -scripting steps. - -In Coder v2, workspaces are defined as [Terraform -templates](https://coder.com/docs/coder-oss/latest/templates) with Terraform -resources to specify the infrastructure provider and compute type. e.g., -Kubernetes pod, Docker container, or VM. Docker or alternatively VM images are -specified in the template. The template includes an agent resource and +In v1, workspaces are Kubernetes pods with an inner container based on +[container images](../images/index.md) with an optional configure script in the +image that runs additional configurations as the non-root user after the +workspace is built. Coder v1 has an optional workspace template yaml spec to +define compute and additional bash scripting steps. + +In Coder v2, workspaces are defined as +[Terraform templates](https://coder.com/docs/coder-oss/latest/templates) with +Terraform resources to specify the infrastructure provider and compute type. +e.g., Kubernetes pod, Docker container, or VM. Docker or alternatively VM images +are specified in the template. The template includes an agent resource and `startup_script` configuration that can run the configure script in the image or additional steps like in v1 workspace templates. Coder v1 workspace applications are configured as `coder_app` resources in the Terraform template. @@ -95,8 +95,8 @@ Integration points remain the same like [OIDC](https://coder.com/docs/coder-oss/latest/admin/auth) for single-sign-on and specifying image registries in v2 templates. -Out-of-the-box Git authentication in v1 is an OAuth app and SSH. In v2, [OAuth -is used as well](https://coder.com/docs/coder-oss/latest/admin/git-providers) +Out-of-the-box Git authentication in v1 is an OAuth app and SSH. In v2, +[OAuth is used as well](https://coder.com/docs/coder-oss/latest/admin/git-providers) but Coder intercepts git actions, forcing the user to authenticate to their git provider. Coder stores the user's OAuth token in the Coder database and using it for subsequent git actions. In v2, Coder issues an SSH key to each user if that @@ -110,8 +110,8 @@ is preferred. No. The database schema and architectural concepts are so different in v2, it is not reasonable to build migration scripts that meet all customer deployment scenarios. See [the migration strategy](./moving-to-oss.md#migration-strategy) -and [recommendations on moving workspace -contents](./moving-to-oss.md#workspaces). +and +[recommendations on moving workspace contents](./moving-to-oss.md#workspaces).
@@ -128,6 +128,5 @@ community.
-> For more information on Coder v2 concepts, please review the [Moving to Coder -> v2](./moving-to-oss.md) guide. - +> For more information on Coder v2 concepts, please review the +> [Moving to Coder v2](./moving-to-oss.md) guide. diff --git a/index.md b/index.md index 09f6e8616..cbcf8d65f 100644 --- a/index.md +++ b/index.md @@ -3,12 +3,15 @@ title: "Home" description: "Explore our guides and examples to get started with Coder." --- -Coder v1 is a self-hosted platform that allows organizations to securely provision -developer workspaces (featuring remote IDEs and all related resources) for -DevOps, platform, and software engineering teams. +Coder v1 is a self-hosted platform that allows organizations to securely +provision developer workspaces (featuring remote IDEs and all related resources) +for DevOps, platform, and software engineering teams. ## News ✨ - Coder will sunset support for Coder v1 starting in mid-2023 and is encouraging customers to install and deploy Coder v2. [See Frequently Asked Questions](./guides/v2-faq.md). + +Coder will sunset support for Coder v1 starting in mid-2023 and is encouraging +customers to install and deploy Coder v2. +[See Frequently Asked Questions](./guides/v2-faq.md).
From 36a29175194ded17b0230474b1b92fc5167c50dc Mon Sep 17 00:00:00 2001 From: Steven Masley Date: Tue, 3 Jan 2023 09:27:47 -0600 Subject: [PATCH 8/8] Make format --- manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index f16e09df3..6434d313f 100644 --- a/manifest.json +++ b/manifest.json @@ -595,7 +595,7 @@ }, { "path": "./guides/v2-faq.md" - } + } ] }, {
Organization managerOrganization super manager Grants full administrative access to the organization and the ability to manage its images and members. Can view, modify, and delete workspaces belonging to members of the organization.
Organization managerGrants create, view, modify, and delete to the organization's + images, image tags, and registries.
Organization image managerGrants create, view, modify, and delete to the organization's + images, and image tags.
Organization importerIn addition to basic organization access, Can create new + images assigned to the organization.
Organization member Grants basic organization access. Can use and view images - belonging to the organization. Can create new - images assigned to the organization. Can only access + belonging to the organization. Can only access workspaces within their organization.
Organization importerIn addition to basic organization access, Can create new + In addition to basic organization access, can create new images assigned to the organization.
ImagesX X
Image tagsX X X XXX X
Workspaces X XX X XWorkspaces X XX X
Workspaces XX X X
Workspaces XX X X
Workspaces XX X X