2.4 Documentation

[russjones]

The following issues highlight the changes we've made in code that need to be reflected within the Teleport and Enterprise documentation:

RoleV3 #1092

• Document new format for the Role resource.
• Document supported rules.
• Document Allow and Deny conditions.
• Document how roles can be combined in AND, OR, and NOT.
• Document how access to a server checked (namespace, label, and logins).
• Document how access to a rule is checked (namespace and rule).

Role Variables #1120

• Add note that role templates are deprecated in 2.3 and will be removed in 2.4.
• Document role variable syntax.
• Document how to use role variables.
• Document that role variables can not be used with Trusted Clusters.

Default Role #1136 #1279

• Document the capabilities of the admin role.
• Document that all local users assume the role admin.
• Document that Teleport and Enterprise admin roles differ.

Cluster Configuration #1098

• All cluster configuration now must be done from teleport.yaml.
• Cluster configuration consists of: cluster name, static tokens, and authentication preference.
• ClusterName can only be set once.
• OIDC/SAML connectors must be created using tctl.
• tsh now has a --auth flag used to select the non-default connector.

tctl #1137

• Document resource commands: get, rm and create.
• Rename del to rm everywhere.

Trusted Cluster Toggle #1199

• Document how to add Trusted Cluster using a resource.
• Document how to enable/disable a Trusted cluster.

Role Rules #1200

• Document supported rules.
• Document supported verbs.
• Document default role.
• Document an example administrator role (all verbs for all rules).
• Document an example partial partial administrator role (all verbs for some rules).

Session Access Controls #1223

• Document how session access controls work at the moment (list, read)
• Document how sessions access controls for Trusted Cluster rely on the role assumed in the Trusted Cluster not your local rule.

Rule Processing #1222

• Document how where and actions fields work in in rules

[kontsevoy]

Most of the documentation has been done. The remainder is going into 2.4

[kontsevoy]

Instead of closing it, I renamed it to 2.4.1 (because most of 2.4 features have been covered, except a few chapters I still want to add)

[kontsevoy]

Moved to #1720