From 809ea8ec35528510f67a59feb911032b45e88de2 Mon Sep 17 00:00:00 2001 From: lsgunn-teleport <136391445+lsgunn-teleport@users.noreply.github.com> Date: Tue, 3 Oct 2023 10:10:22 -0700 Subject: [PATCH] [v14] docs: change open source/OSS references to community edition (#32877) * Change Open source and OSS to Teleport Community Edition * Change open-source to Teleport Community Edition * Role access requests in the nav and title --- docs/config.json | 2 +- docs/pages/access-controls/access-requests.mdx | 6 +++--- .../access-requests/oss-role-requests.mdx | 15 +++++++-------- .../access-requests/resource-requests.mdx | 2 +- .../access-requests/role-requests.mdx | 2 +- docs/pages/access-controls/idps/saml-grafana.mdx | 2 +- .../pages/application-access/cloud-apis/azure.mdx | 4 ++-- docs/pages/choose-an-edition/introduction.mdx | 2 +- .../choose-an-edition/teleport-cloud/faq.mdx | 2 +- .../contributing/documentation/reference.mdx | 4 ++-- .../deployments/aws-terraform.mdx | 11 ++++++----- docs/pages/faq.mdx | 2 +- .../includes/config-reference/auth-service.yaml | 6 +++--- docs/pages/includes/ent-vs-community-faq.mdx | 2 +- docs/pages/installation.mdx | 2 +- .../machine-id/reference/v14-upgrade-guide.mdx | 2 +- .../pages/management/admin/uninstall-teleport.mdx | 8 ++++---- .../management/export-audit-events/fluentd.mdx | 2 +- .../reference/helm-reference/teleport-cluster.mdx | 2 +- docs/pages/reference/terraform-provider.mdx | 2 +- 20 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/config.json b/docs/config.json index 610c0bdec514c..0e7f9c8dcd4ba 100644 --- a/docs/config.json +++ b/docs/config.json @@ -580,7 +580,7 @@ ] }, { - "title": "Role Requests in OSS Teleport", + "title": "Teleport Community Edition Role Access Requests", "slug": "/access-controls/access-requests/oss-role-requests/", "forScopes": [ "oss" diff --git a/docs/pages/access-controls/access-requests.mdx b/docs/pages/access-controls/access-requests.mdx index bf10ac0eb7218..16ed2732b7ac4 100644 --- a/docs/pages/access-controls/access-requests.mdx +++ b/docs/pages/access-controls/access-requests.mdx @@ -15,13 +15,13 @@ time. Request approvers can be configured with limited cluster access so they are not high value targets. Just-in-time Access Requests are a feature of Teleport Enterprise. -Open-source Teleport users can get a preview of how Access Requests work by +Teleport Community Edition users can get a preview of how Access Requests work by requesting a role via the Teleport CLI. Full Access Request functionality, including Resource Access Requests and an intuitive and searchable UI are available in Teleport Enterprise. -For information on how to use Just-in-time Access Requests with OSS Teleport, -see the [OSS Guide](./access-requests/oss-role-requests.mdx). +For information on how to use Just-in-time Access Requests with Teleport Community +Edition, see [Teleport Community Access Requests](./access-requests/oss-role-requests.mdx). ## Resource Access Requests diff --git a/docs/pages/access-controls/access-requests/oss-role-requests.mdx b/docs/pages/access-controls/access-requests/oss-role-requests.mdx index 91476769428de..7e08b72e09aad 100644 --- a/docs/pages/access-controls/access-requests/oss-role-requests.mdx +++ b/docs/pages/access-controls/access-requests/oss-role-requests.mdx @@ -1,13 +1,12 @@ --- -title: Just-in-time Access Requests in OSS Teleport -description: OSS Teleport allows users to request access to roles from the CLI. -h1: Teleport Resource Access Requests +title: Teleport Community Edition Role Access Requests +description: Teleport Community Edition allows users to request access to roles from the CLI. --- Just-in-time Access Requests are a feature of Teleport Enterprise. -Open-source Teleport users can get a preview of how Access Requests work by -requesting a role via the Teleport CLI. Full Access Request functionality, +Teleport Community Edition users can get a preview of how Access Requests work by +requesting a role using the Teleport CLI. Full Access Request functionality, including Resource Access Requests and an intuitive and searchable UI are available in Teleport Enterprise. @@ -20,7 +19,7 @@ users can request access to. In this example, we will define two roles: - `dba`: this role grants access to databases There is no role for request approvers, because request approval rules can only -be configured for Teleport Enterprise. In Open Source Teleport, approvals must +be configured for Teleport Enterprise. In Teleport Community Edition, approvals must be performed by running `tctl` on the Auth Server. **Contractor role** @@ -77,7 +76,7 @@ $ tctl create dba-role.yaml ## Requesting Access -In OSS Teleport, requests are made from the `tsh` CLI. To create an access +In Teleport Community Edition, requests are made from the `tsh` CLI. To create an access request, use the `tsh request create` command. ```code @@ -121,7 +120,7 @@ $ tsh request ls ## Reviewing requests -In OSS Teleport, Access Requests must be reviewed by a cluster administrator +In Teleport Community Edition, Access Requests must be reviewed by a cluster administrator with the ability to run `tctl` on the Auth Server. Administrators can list requests with `tctl requests ls`, and view the details diff --git a/docs/pages/access-controls/access-requests/resource-requests.mdx b/docs/pages/access-controls/access-requests/resource-requests.mdx index 3a6ceefe2d323..484111bb317df 100644 --- a/docs/pages/access-controls/access-requests/resource-requests.mdx +++ b/docs/pages/access-controls/access-requests/resource-requests.mdx @@ -15,7 +15,7 @@ The Access Request API makes it easy to dynamically approve or deny these requests. Just-in-time Access Requests are a feature of Teleport Enterprise. -Open-source Teleport users can get a preview of how Access Requests work by +Teleport Community Edition users can get a preview of how Access Requests work by requesting a role via the Teleport CLI. Full Access Request functionality, including Resource Access Requests and an intuitive and searchable UI are available in Teleport Enterprise. diff --git a/docs/pages/access-controls/access-requests/role-requests.mdx b/docs/pages/access-controls/access-requests/role-requests.mdx index e7f0097fb3c27..b3167efa6f04b 100644 --- a/docs/pages/access-controls/access-requests/role-requests.mdx +++ b/docs/pages/access-controls/access-requests/role-requests.mdx @@ -74,7 +74,7 @@ spec: Roles containing a `review_requests` rule can only be used in Teleport -Enterprise. In OSS Teleport, Access Requests must be approved by an admin +Enterprise. In Teleport Community Edition, Access Requests must be approved by an admin running `tctl` on the Auth Server. diff --git a/docs/pages/access-controls/idps/saml-grafana.mdx b/docs/pages/access-controls/idps/saml-grafana.mdx index 6834dc2bc2534..230037bcbfba5 100644 --- a/docs/pages/access-controls/idps/saml-grafana.mdx +++ b/docs/pages/access-controls/idps/saml-grafana.mdx @@ -3,7 +3,7 @@ title: Use Teleport's SAML Provider to authenticate with Grafana description: Configure Grafana to use identities provided by Teleport. --- -Grafana is an open-source observability platform. Their enterprise version supports +Grafana is an open source observability platform. Their enterprise version supports SAML authentication. This guide will help you configure Teleport as a SAML provider, and Grafana to accept the identities it provides. diff --git a/docs/pages/application-access/cloud-apis/azure.mdx b/docs/pages/application-access/cloud-apis/azure.mdx index b84c15cef0ec9..2aadd8478aaed 100644 --- a/docs/pages/application-access/cloud-apis/azure.mdx +++ b/docs/pages/application-access/cloud-apis/azure.mdx @@ -222,8 +222,8 @@ identities. We recommend using the dynamic approach, since it scales more easily as you add -Azure identities to your account. If you have configured an open source Teleport -cluster to authenticate users via GitHub SSO, you must use the static approach, +Azure identities to your account. If you have configured a Teleport Community Edition +cluster to authenticate users using GitHub SSO, you must use the static approach, as OAuth-based GitHub applications do not support custom claims. diff --git a/docs/pages/choose-an-edition/introduction.mdx b/docs/pages/choose-an-edition/introduction.mdx index 9df77665bd3e8..6dcf85de17061 100644 --- a/docs/pages/choose-an-edition/introduction.mdx +++ b/docs/pages/choose-an-edition/introduction.mdx @@ -1,6 +1,6 @@ --- title: "How to Choose a Teleport Edition" -description: "Read this guide to determine whether to deploy Teleport Enterprise, Teleport Cloud, or Open Source Teleport" +description: "Read this guide to determine whether to deploy Teleport Enterprise, Teleport Cloud, or Teleport Community Edition." --- Teleport supports four editions. In this guide, we will help you determine diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index a0994aabec2f9..985987fdf766d 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -86,7 +86,7 @@ There is no need to open any ports on your infrastructure for inbound traffic. If you plan on connecting more than 10,000 nodes or agents, please contact your account executive or customer support to ensure your tenant is properly scaled. -### Should we use Enterprise or Open Source Teleport for connecting resources to our Teleport cluster? +### Should we use Enterprise or Teleport Community Edition for connecting resources to our Teleport cluster? (!docs/pages/includes/ent-vs-community-faq.mdx!) ### Are dynamic node tokens available? diff --git a/docs/pages/contributing/documentation/reference.mdx b/docs/pages/contributing/documentation/reference.mdx index aeeccd16bc540..23542450ee241 100644 --- a/docs/pages/contributing/documentation/reference.mdx +++ b/docs/pages/contributing/documentation/reference.mdx @@ -527,7 +527,7 @@ component if the user selects the appropriate scope: - Here are instructions for users of open source Teleport and Teleport + Here are instructions for users of Teleport Community Edition and Teleport Enterprise. @@ -544,7 +544,7 @@ Here is the result: - Here are instructions for users of open source Teleport and Teleport + Here are instructions for users of Teleport Community Edition and Teleport Enterprise. diff --git a/docs/pages/deploy-a-cluster/deployments/aws-terraform.mdx b/docs/pages/deploy-a-cluster/deployments/aws-terraform.mdx index 7068a3a11ad19..8841c9a0005bc 100644 --- a/docs/pages/deploy-a-cluster/deployments/aws-terraform.mdx +++ b/docs/pages/deploy-a-cluster/deployments/aws-terraform.mdx @@ -152,8 +152,8 @@ cluster from scratch, so choose carefully. Setting `export TF_VAR_ami_name="gravitational-teleport-ami-ent-(=teleport.version=)"` -Gravitational automatically builds and publishes OSS, Enterprise and Enterprise FIPS 140-2 AMIs when we -release a new version of Teleport. The AMI names follow the format: `gravitational-teleport-ami--` +Gravitational automatically builds and publishes Teleport Community Edition, Enterprise, and Enterprise FIPS 140-2 +AMIs when we release a new version of Teleport. The AMI names follow the format: `gravitational-teleport-ami--` where `` is either `oss` or `ent` (Enterprise) and `version` is the version of Teleport e.g. `(=teleport.version=)`. FIPS 140-2 compatible AMIs (which deploy Teleport in FIPS 140-2 mode by default) have the `-fips` suffix. @@ -190,9 +190,10 @@ EC2 instances. Do not use a keypair that you do not have access to. Set `export TF_VAR_license_path="/home/user/license.pem"` This license will be uploaded to AWS SSM and automatically downloaded to Teleport auth nodes in order to enable -Teleport Enterprise/Pro functionality. +Teleport Enterprise functionality. -(OSS users can provide any valid local file path here - it isn't used by the auth server in a Teleport OSS install) +(Teleport Community Edition users can provide any valid local file path here. It isn't used by the Teleport Auth +Service in a Teleport Community Edition installs.) ### route53\_zone @@ -525,7 +526,7 @@ You can use the Teleport command line tool (`tsh`) to log into your Teleport clu You can [download the Teleport package containing the `tsh` client from here](https://goteleport.com/download) -- the client is the same for both OSS and Enterprise versions of Teleport. +- the client is the same for both Teleport Community Edition and Teleport Enterprise. diff --git a/docs/pages/faq.mdx b/docs/pages/faq.mdx index 6651c6b29981b..47a6e3615aaa8 100644 --- a/docs/pages/faq.mdx +++ b/docs/pages/faq.mdx @@ -37,7 +37,7 @@ Yes, Teleport supports reverse SSH tunnels out of the box. To configure behind-firewall clusters refer to our [Trusted Clusters](./management/admin/trustedclusters.mdx) guide. -## Should we use Enterprise or Open Source Teleport for connecting resources to our Teleport cluster? +## Should we use Teleport Enterprise or Teleport Community Edition for connecting resources to our Teleport cluster? (!docs/pages/includes/ent-vs-community-faq.mdx!) ## Can individual agents create reverse tunnels to the Proxy Service without creating a new cluster? diff --git a/docs/pages/includes/config-reference/auth-service.yaml b/docs/pages/includes/config-reference/auth-service.yaml index e2c0341290e6b..7c2d8fc35bb79 100644 --- a/docs/pages/includes/config-reference/auth-service.yaml +++ b/docs/pages/includes/config-reference/auth-service.yaml @@ -140,7 +140,7 @@ auth_service: authentication: # default authentication type. possible values are 'local' and 'github' - # for OSS, plus 'oidc' and 'saml' for Enterprise. + # for Teleport Community Edition, plus 'oidc' and 'saml' for Enterprise. # Only local authentication (Teleport's own user DB) & GitHub is # supported in the open source version type: local @@ -256,7 +256,7 @@ auth_service: # - 'required' - enables device authentication and device-aware audit. # Additionally, it requires a trusted device for all SSH, Database # and Kubernetes connections. - mode: optional # always "off" for OSS + mode: optional # always "off" for Teleport Community Edition # Determines the default time to live for user certificates # issued by this auth server, defaults to 12 hours. Examples: @@ -342,7 +342,7 @@ auth_service: routing_strategy: unambiguous_match # License file to start auth server with. Note that this setting is ignored - # in the Teleport Open-Source Edition and is required only for Teleport Pro, Business + # in the Teleport Community Edition and is required only for Teleport Pro, Business # and Enterprise subscription plans. # # The path can be either absolute or relative to the configured `data_dir` diff --git a/docs/pages/includes/ent-vs-community-faq.mdx b/docs/pages/includes/ent-vs-community-faq.mdx index f893b1feff2fb..05be6c16766dd 100644 --- a/docs/pages/includes/ent-vs-community-faq.mdx +++ b/docs/pages/includes/ent-vs-community-faq.mdx @@ -19,4 +19,4 @@ $ teleport version ``` See the [Installation](../installation.mdx) guide for details on installing to specific platforms -with Enterprise or OSS releases. +with Enterprise or Teleport Community Edition releases. diff --git a/docs/pages/installation.mdx b/docs/pages/installation.mdx index 2db1f20d7ab18..76f7dae86bb9d 100644 --- a/docs/pages/installation.mdx +++ b/docs/pages/installation.mdx @@ -455,7 +455,7 @@ chart. Enterprise and Enterprise Cloud, we recommend installing the official Teleport Enterprise edition of `tctl`. - ### Installing open source Teleport with Homebrew + ### Installing Teleport with Homebrew To install Teleport with Homebrew, run the following command: diff --git a/docs/pages/machine-id/reference/v14-upgrade-guide.mdx b/docs/pages/machine-id/reference/v14-upgrade-guide.mdx index 4c0b9414882a1..5ad26a4b422e7 100644 --- a/docs/pages/machine-id/reference/v14-upgrade-guide.mdx +++ b/docs/pages/machine-id/reference/v14-upgrade-guide.mdx @@ -83,5 +83,5 @@ might not have validated for these. If you are still unable to determine why your configuration will not migrate, seek guidance. If you have a support contract, submit a ticket. If you are using -open source Teleport, join our +Teleport Community Edition, join our [community Slack](https://goteleport.com/community-slack/). diff --git a/docs/pages/management/admin/uninstall-teleport.mdx b/docs/pages/management/admin/uninstall-teleport.mdx index 4acd8a30362ea..837280fbe35ac 100644 --- a/docs/pages/management/admin/uninstall-teleport.mdx +++ b/docs/pages/management/admin/uninstall-teleport.mdx @@ -303,7 +303,7 @@ $ docker stop teleport ```code $ sudo apt-get -y remove teleport-ent - # NOTE: Older Cloud users may be running OSS binaries instead + # NOTE: Older Cloud users may be running Teleport Community Edition binaries instead # $ sudo apt-get -y remove teleport ``` @@ -318,7 +318,7 @@ $ docker stop teleport ```code $ sudo dpkg -r teleport-ent - # NOTE: Older Cloud users may be running OSS binaries instead + # NOTE: Older Cloud users may be running Teleport Community Edition binaries instead # $ sudo dpkg -r teleport ``` @@ -332,7 +332,7 @@ $ docker stop teleport $ sudo yum -y remove teleport-ent # Optional: Use DNF on newer distributions # $ sudo dnf -y remove teleport-ent - # NOTE: Older Cloud users may be running OSS binaries instead + # NOTE: Older Cloud users may be running Teleport Community Edition binaries instead # $ sudo yum -y remove teleport # $ sudo dnf -y remove teleport ``` @@ -348,7 +348,7 @@ $ docker stop teleport ```code $ sudo rpm -e teleport-ent - # NOTE: Older Cloud users may be running OSS binaries instead + # NOTE: Older Cloud users may be running Teleport Community Edition binaries instead # $ sudo rpm -e teleport ``` diff --git a/docs/pages/management/export-audit-events/fluentd.mdx b/docs/pages/management/export-audit-events/fluentd.mdx index bba38949422e7..24fdec63676f2 100644 --- a/docs/pages/management/export-audit-events/fluentd.mdx +++ b/docs/pages/management/export-audit-events/fluentd.mdx @@ -4,7 +4,7 @@ description: Forwarding events with Fluentd and Teleport event handler videoBanner: HAqxs4rBv2c --- -Fluentd is an open-source data collector for a unified logging layer. In this +Fluentd is an open source data collector for a unified logging layer. In this guide, we will: - Set up Teleport's Event Handler plugin. diff --git a/docs/pages/reference/helm-reference/teleport-cluster.mdx b/docs/pages/reference/helm-reference/teleport-cluster.mdx index 35179c91b6a53..b53a00247131c 100644 --- a/docs/pages/reference/helm-reference/teleport-cluster.mdx +++ b/docs/pages/reference/helm-reference/teleport-cluster.mdx @@ -241,7 +241,7 @@ proxy: | `string` | `local` | Yes | `auth_service.authentication.type` | `authentication.type` controls the authentication scheme used by Teleport. -Possible values are `local` and `github` for OSS, plus `oidc` and `saml` for Enterprise. +Possible values are `local` and `github` for Teleport Community Edition, plus `oidc` and `saml` for Enterprise. ### `authentication.connectorName` diff --git a/docs/pages/reference/terraform-provider.mdx b/docs/pages/reference/terraform-provider.mdx index 9fc4f0ba05868..3ed283811cb06 100644 --- a/docs/pages/reference/terraform-provider.mdx +++ b/docs/pages/reference/terraform-provider.mdx @@ -389,7 +389,7 @@ DeviceTrust holds settings related to trusted device verification. Requires Tele |--------------------|------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | auto_enroll | bool | | Enable device auto-enroll. Auto-enroll lets any user issue a device enrollment token for a known device that is not already enrolled. `tsh` takes advantage of auto-enroll to automatically enroll devices on user login, when appropriate. The effective cluster Mode still applies: AutoEnroll=true is meaningless if Mode="off". | | ekcert_allowed_cas | array of strings | | Allow list of EKCert CAs in PEM format. If present, only TPM devices that present an EKCert that is signed by a CA specified here may be enrolled (existing enrollments are unchanged). If not present, then the CA of TPM EKCerts will not be checked during enrollment, this allows any device to enroll. | -| mode | string | | Mode of verification for trusted devices. The following modes are supported: - "off": disables both device authentication and authorization. - "optional": allows both device authentication and authorization, but doesn't enforce the presence of device extensions for sensitive endpoints. - "required": enforces the presence of device extensions for sensitive endpoints. Mode is always "off" for OSS. Defaults to "optional" for Enterprise. | +| mode | string | | Mode of verification for trusted devices. The following modes are supported: - "off": disables both device authentication and authorization. - "optional": allows both device authentication and authorization, but doesn't enforce the presence of device extensions for sensitive endpoints. - "required": enforces the presence of device extensions for sensitive endpoints. Mode is always "off" for Teleport Community Edition. Defaults to "optional" for Enterprise. | #### spec.idp