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.

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

[v14] Restructure docs menu pages #48151

Merged
merged 1 commit into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 18 additions & 17 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,8 @@ applications in Kubernetes clusters. When connected to a Kubernetes cluster (or
deployed as a Helm chart), the Teleport Discovery Service will automatically find
and enroll web applications with your Teleport cluster.

See documentation [here](docs/pages/enroll-resources/application-access/enroll-kubernetes-applications.mdx).
See documentation
[here](docs/pages/enroll-resources/application-access/enroll-kubernetes-applications/kubernetes-applications.mdx).

#### Extended Kubernetes per-resource RBAC

Expand Down Expand Up @@ -1761,7 +1762,7 @@ This will allow users to view the OpenSSH nodes in Web UI and using `tsh ls`
and use RBAC to control access to them.

See the updated [OpenSSH integration
guide](docs/pages/enroll-resources/server-access/guides/openssh.mdx).
guide](docs/pages/enroll-resources/server-access/guides/openssh/openssh.mdx).

### Cross-cluster search for Teleport Connect

Expand Down Expand Up @@ -2962,7 +2963,7 @@ is more than one major version behind them. You can use the `--skip-version-chec
bypass the version check.

Take a look at component compatibility guarantees in the
[documentation](docs/pages/upgrading.mdx).
[documentation](docs/pages/upgrading/upgrading.mdx).

#### HTTP_PROXY for reverse tunnels

Expand Down Expand Up @@ -3951,7 +3952,7 @@ if err = clt.CreateAccessRequest(ctx, accessRequest); err != nil {

### Upgrade Notes

Please follow our [standard upgrade procedure](docs/pages/admin-guides/management/admin.mdx) to upgrade your cluster.
Please follow our [standard upgrade procedure](docs/pages/admin-guides/management/admin/admin.mdx) to upgrade your cluster.

Note, for clusters using GitHub SSO and Trusted Clusters, when upgrading SSO users will lose connectivity to leaf clusters. Local users will not be affected.

Expand Down Expand Up @@ -4201,8 +4202,8 @@ Teleport 5.0 also iterates on the UI Refresh from 4.3. We've moved the cluster l
Other updates:

* We now provide local user management via `https://[cluster-url]/web/users`, providing the ability to edit, reset and delete local users.
* Teleport Node & App Install scripts. This is currently an Enterprise-only feature that provides customers with an installer script. Enterprise customers can enable this feature by modifying the 'token' resource. See note above.
* We've added a Waiting Room for customers using Access Workflows. [Docs](docs/pages/admin-guides/access-controls/access-request-plugins.mdx)
* Teleport Node & App Install scripts. This is currently an Enterprise-only feature that provides customers with an 'auto-magic' installer script. Enterprise customers can enable this feature by modifying the 'token' resource. See note above.
* We've added a Waiting Room for customers using Access Workflows. [Docs](docs/pages/admin-guides/access-controls/access-request-plugins/access-request-plugins.mdx)

##### Signed RPM and Releases

Expand Down Expand Up @@ -4236,7 +4237,7 @@ We've added an [API Guide](docs/pages/admin-guides/api/api.mdx) to simply develo

#### Upgrade Notes

Please follow our [standard upgrade procedure](./docs/pages/upgrading.mdx).
Please follow our [standard upgrade procedure](docs/pages/upgrading/upgrading.mdx).

* Optional: Consider updating `https_key_file` & `https_cert_file` to our new `https_keypairs:` format.
* Optional: Consider migrating Kubernetes access from `proxy_service` to `kubernetes_service` after the upgrade.
Expand Down Expand Up @@ -4380,7 +4381,7 @@ auth_service:
#### Upgrade Notes

Please follow our [standard upgrade
procedure](docs/pages/upgrading.mdx).
procedure](docs/pages/upgrading/upgrading.mdx).

## 4.3.9

Expand Down Expand Up @@ -4465,7 +4466,7 @@ Teleport's Web UI now exposes Teleport’s Audit log, letting auditors and admin

##### Teleport Plugins

Teleport 4.3 introduces four new plugins that work out of the box with [Approval Workflow](docs/pages/admin-guides/access-controls/access-request-plugins.mdx). These plugins allow you to automatically support role escalation with commonly used third party services. The built-in plugins are listed below.
Teleport 4.3 introduces four new plugins that work out of the box with [Approval Workflow](docs/pages/admin-guides/access-controls/access-request-plugins/access-request-plugins.mdx). These plugins allow you to automatically support role escalation with commonly used third party services. The built-in plugins are listed below.

* [PagerDuty](docs/pages/admin-guides/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx)
* [Jira](docs/pages/admin-guides/access-controls/access-request-plugins/ssh-approval-jira.mdx)
Expand Down Expand Up @@ -4501,7 +4502,7 @@ Teleport 4.3 introduces four new plugins that work out of the box with [Approval
#### Upgrade Notes

Always follow the [recommended upgrade
procedure](./docs/pages/upgrading.mdx) to upgrade to this version.
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this version.

##### New Signing Algorithm

Expand Down Expand Up @@ -4542,7 +4543,7 @@ permissions](./docs/pages/enroll-resources/kubernetes-access/controls.mdx).
The [etcd backend](docs/pages/reference/backends.mdx#etcd) now correctly uses
the “prefix” config value when storing data. Upgrading from 4.2 to 4.3 will
migrate the data as needed at startup. Make sure you follow our Teleport
[upgrade guidance](docs/pages/upgrading.mdx).
[upgrade guidance](docs/pages/upgrading/upgrading.mdx).

**Note: If you use an etcd backend with a non-default prefix and need to downgrade from 4.3 to 4.2, you should [backup Teleport data and restore it](docs/pages/admin-guides/management/operations/backup-restore.mdx) into the downgraded cluster.**

Expand Down Expand Up @@ -4665,7 +4666,7 @@ This is a minor Teleport release with a focus on new features and bug fixes.
### Improvements

* Alpha: Enhanced Session Recording lets you know what's really happening during a Teleport Session. [#2948](https://github.com/gravitational/teleport/issues/2948)
* Alpha: Workflows API lets admins escalate RBAC roles in response to user requests. [Read the docs](docs/pages/admin-guides/access-controls/access-requests.mdx). [#3006](https://github.com/gravitational/teleport/issues/3006)
* Alpha: Workflows API lets admins escalate RBAC roles in response to user requests. [Read the docs](docs/pages/admin-guides/access-controls/access-requests/access-requests.mdx). [#3006](https://github.com/gravitational/teleport/issues/3006)
* Beta: Teleport provides HA Support using Firestore and Google Cloud Storage using Google Cloud Platform. [Read the docs](docs/pages/admin-guides/deploy-a-cluster/deployments/gcp.mdx). [#2821](https://github.com/gravitational/teleport/pull/2821)
* Remote tctl execution is now possible. [Read the docs](./docs/pages/reference/cli/tctl.mdx). [#1525](https://github.com/gravitational/teleport/issues/1525) [#2991](https://github.com/gravitational/teleport/issues/2991)

Expand Down Expand Up @@ -4921,7 +4922,7 @@ The lists of improvements and bug fixes above mention only the significant chang

### Upgrading

Teleport 4.0 is backwards compatible with Teleport 3.2 and later. [Follow the recommended upgrade procedure to upgrade to this version.](docs/pages/upgrading.mdx)
Teleport 4.0 is backwards compatible with Teleport 3.2 and later. [Follow the recommended upgrade procedure to upgrade to this version.](docs/pages/upgrading/upgrading.mdx)

Note that due to substantial changes between Teleport 3.2 and 4.0, we recommend creating a backup of the backend datastore (DynamoDB, etcd, or dir) before upgrading a cluster to Teleport 4.0 to allow downgrades.

Expand Down Expand Up @@ -5189,7 +5190,7 @@ on Github for more.
#### Upgrading to 3.0

Follow the [recommended upgrade
procedure](docs/pages/upgrading.mdx) to upgrade to this
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this
version.

**WARNING:** if you are using Teleport with the etcd back-end, make sure your
Expand Down Expand Up @@ -5295,7 +5296,7 @@ As always, this release contains several bug fixes. The full list can be seen [h
#### Upgrading

Follow the [recommended upgrade
procedure](docs/pages/upgrading.mdx) to upgrade to this
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this
version.

## 2.6.9
Expand Down Expand Up @@ -5425,7 +5426,7 @@ You can see the full list of 2.6.0 changes [here](https://github.com/gravitation
#### Upgrading

Follow the [recommended upgrade
procedure](docs/pages/upgrading.mdx) to upgrade to this
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this
version.

## 2.5.7
Expand Down Expand Up @@ -5512,7 +5513,7 @@ release, which includes:

* The Teleport daemon now implements built-in connection draining which allows
zero-downtime upgrades. [See
documentation](docs/pages/upgrading.mdx).
documentation](docs/pages/upgrading/upgrading.mdx).

* Dynamic join tokens for new nodes can now be explicitly set via `tctl node add --token`.
This allows Teleport admins to use an external mechanism for generating
Expand Down
2 changes: 1 addition & 1 deletion docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
{
"title": "Upgrading",
"slug": "/upgrading/",
"slug": "/upgrading/upgrading/",
"entries": [
{
"title": "Compatibility Overview",
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/admin-guides/access-controls/access-controls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ that specifies access policies for resources in your Teleport cluster.
Assigning a role to a Teleport user applies the policies listed in the role to
the user.

See the [Cluster Access and RBAC](./guides.mdx) section for instructions on
See the [Cluster Access and RBAC](guides/guides.mdx) section for instructions on
setting up Teleport roles.

## Integrate with your Single Sign-On provider
Expand All @@ -46,7 +46,7 @@ automatically assigns roles to the user based on data provided by the IdP. This
means that you can implement a fully fledged infrastructure RBAC system based on
your existing Single Sign-On solution.

Read our [Single Sign-On guide](./sso.mdx) to get started.
Read our [Single Sign-On guide](sso/sso.mdx) to get started.

## Enable Access Requests

Expand All @@ -55,13 +55,13 @@ resources in your infrastructure based on the approval of other users. You can
set up your RBAC so all privileged access is short lived, and there are no
longstanding admin roles for attackers to hijack.

[Get started with Access Requests](./access-requests.mdx).
[Get started with Access Requests](access-requests/access-requests.mdx).

You can integrate Teleport with your existing communication tool, e.g., Slack,
PagerDuty, or Microsoft Teams, so Teleport users can easily create and approve
Access Requests.

[Get started with Access Request plugins](access-request-plugins.mdx).
[Get started with Access Request plugins](access-request-plugins/access-request-plugins.mdx).

## Achieve compliance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ managed within Teleport. With Access Lists, administrators and access list
owners can regularly audit and control membership to specific roles and
traits, which then tie easily back into Teleport's existing RBAC system.

[Getting Started with Access Lists](./access-lists/guide.mdx)
[Getting Started with Access Lists](guide.mdx)

[Access List Reference](../../reference/access-controls/access-lists.mdx)
[Access List Reference](../../../reference/access-controls/access-lists.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ workflows by reading our setup guides:

To read more about the architecture of an Access Request plugin, and start
writing your own, read our [Access Request plugin development
guide](../api/access-plugin.mdx).
guide](../../api/access-plugin.mdx).
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ be configured with limited cluster access so they are not high value targets.
Access Requests are designed to provide temporary permissions to users. If you
want to grant longstanding permissions to a group of users, with the option to
renew these permissions after a recurring interval (such as three months),
consider [Access Lists](access-lists.mdx).
consider [Access Lists](../access-lists/access-lists.mdx).

## See how Access Requests work

Expand All @@ -26,12 +26,12 @@ and **Resource Access Requests**.
With Role Access Requests, engineers can request temporary credentials with
elevated roles in order to perform critical system-wide tasks.

[Get started with Role Access Requests](./access-requests/role-requests.mdx).
[Get started with Role Access Requests](role-requests.mdx).

With Resource Access Requests, engineers can easily get access to only the
individual resources they need, when they need it.

[Get started with Resource Access Requests](./access-requests/resource-requests.mdx).
[Get started with Resource Access Requests](resource-requests.mdx).

## Configure Access Requests

Expand All @@ -44,7 +44,7 @@ including:
- How many users can approve or deny different kinds of requests.

Read the [Access Request
Configuration](access-requests/access-request-configuration.mdx) guide for an
Configuration](access-request-configuration.mdx) guide for an
overview of the configuration options available for Access Requests.

## Teleport Community Edition users
Expand All @@ -56,6 +56,6 @@ including Resource Access Requests managing Access Requests via the Web UI are
available in Teleport Enterprise.

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).
Edition, see [Teleport Community Access Requests](oss-role-requests.mdx).


Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ $ tctl request approve \

## Next Steps

- Learn more about [Access Requests](../access-requests.mdx)
- Learn more about [Access Requests](access-requests.mdx)
- See what additional features are available for
[role requests](./role-requests.mdx) in Teleport Enterprise
- Request access to [specific resources](./resource-requests.mdx) with Teleport Enterprise
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ However, it prevents you from access any resources belonging to another namespac
</Details>

Advanced filters and queries are supported. See our
[filtering reference](../../../reference/cli.mdx) for more information.
[filtering reference](../../../reference/cli/cli.mdx) for more information.

Try narrowing your search to a specific resource you want to access.

Expand Down Expand Up @@ -636,4 +636,4 @@ within your organization's existing messaging and project management solutions.

## Next Steps

- Learn more about [Access Lists](../access-lists.mdx)
- Learn more about [Access Lists](../access-lists/access-lists.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -170,5 +170,5 @@ just-in-time Access Request workflow for your organization.

Access Lists enable you to assign privileges to groups of users for a fixed
period of time. Learn more about Access Lists in the
[documentation](../access-lists.mdx).
[documentation](../access-lists/access-lists.mdx).

Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ settings within Teleport.

Follow our guides to see how to use Teleport to achieve compliance:

- [FedRAMP](./compliance-frameworks/fedramp.mdx)
- [SOC 2](./compliance-frameworks/soc2.mdx)
- [FedRAMP](fedramp.mdx)
- [SOC 2](soc2.mdx)
Loading
Loading