Skip to content

docs: Login Rule k8s operator docs#23888

Merged
nklaassen merged 8 commits intomasterfrom
nklaassen/lr-operator-docs
Apr 25, 2023
Merged

docs: Login Rule k8s operator docs#23888
nklaassen merged 8 commits intomasterfrom
nklaassen/lr-operator-docs

Conversation

@nklaassen
Copy link
Copy Markdown
Contributor

@nklaassen nklaassen commented Mar 31, 2023

This PR adds docs for configuring Login Rules via the Teleport Kubernetes Operator

Issue: #20340

@github-advanced-security
Copy link
Copy Markdown

You have successfully added a new Trivy configuration .github/workflows/trivy.yaml:trivy. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

Comment thread docs/config.json Outdated
Comment thread docs/pages/access-controls/login-rules/kubernetes.mdx Outdated
Comment thread docs/pages/access-controls/login-rules/kubernetes.mdx Outdated
@ptgott
Copy link
Copy Markdown
Contributor

ptgott commented Mar 31, 2023

@nklaassen Thanks for putting this and #23855 together! I think we'll need to deliberate a bit on whether this is the best information architecture for these instructions. Here are some considerations I'm thinking about:

  • Eventually, we want to make the Kubernetes Operator and Terraform first-class approaches to applying configuration resources, with as much prominence in the docs as tctl.

  • The Login Rules subsection of the docs is kind of unique in that it's a subsection devoted to a single feature, with its own reference, introduction, and how-to guide. I like this approach because users can discover the subsection by the name of the feature, and don't need to hunt through the docs to find a relevant how-to guide and reference.

    On the other hand, there are other configuration resources that aren't documented like this, so we'll need to think about how to include Terraform and Kubernetes Operator instructions for those.

We could also worry about the information architecture after editing/merging this guide.

@alexfornuto What do you think?

@nklaassen
Copy link
Copy Markdown
Contributor Author

@ptgott Yeah I really wasn't sure where to place these docs, I am very open to changes. I drafted these guides based on a request from Sasha to write first-class IaC docs for Login Rules (and all new features going forward).

A few things I'm trying to add here over just adding the resources to the respective Terraform or Operator resource reference pages:

  • a couple extra examples of the syntax
  • specific notes on setting up RBAC (in the terraform guide)
  • making sure you are running a new enough version of the helm chart which has the Login Rule CRD (in this operator guide)
  • extra debug commands showing how to make sure the resource is actually installed in the cluster and testing that the syntax is right

@nklaassen nklaassen mentioned this pull request Mar 31, 2023
2 tasks
@alexfornuto
Copy link
Copy Markdown
Contributor

  • The Login Rules subsection of the docs is kind of unique in that it's a subsection devoted to a single feature, with its own reference, introduction, and how-to guide. I like this approach because users can discover the subsection by the name of the feature, and don't need to hunt through the docs to find a relevant how-to guide and reference.
    On the other hand, there are other configuration resources that aren't documented like this, so we'll need to think about how to include Terraform and Kubernetes Operator instructions for those.

I agree, and think we should move forward with this approach and possibly even adjust other content to match.

We could also worry about the information architecture after editing/merging this guide.

Yes. Let's get it into the docs as is, to better review and structure holistically.

Comment thread docs/pages/access-controls/login-rules/kubernetes.mdx Outdated
Comment thread docs/pages/access-controls/login-rules/kubernetes.mdx Outdated
@nklaassen nklaassen force-pushed the nklaassen/lr-tf-docs branch from a82fc48 to 13b0e1a Compare April 12, 2023 20:40
@nklaassen nklaassen force-pushed the nklaassen/lr-operator-docs branch from e40c4bc to 3faaf2a Compare April 12, 2023 21:04
@nklaassen
Copy link
Copy Markdown
Contributor Author

Hey @alexfornuto I ran through this guide again on 12.1.5, everything is working for me on this version, this is ready for review

@nklaassen nklaassen requested a review from alexfornuto April 13, 2023 15:34
@nklaassen nklaassen force-pushed the nklaassen/lr-tf-docs branch from 13b0e1a to 9aae777 Compare April 14, 2023 22:08
Base automatically changed from nklaassen/lr-tf-docs to master April 17, 2023 16:43
@nklaassen nklaassen force-pushed the nklaassen/lr-operator-docs branch from 3faaf2a to 83b95f0 Compare April 19, 2023 19:01
Comment thread docs/pages/access-controls/login-rules/kubernetes.mdx Outdated
Comment thread docs/pages/access-controls/login-rules/kubernetes.mdx Outdated
@alexfornuto

This comment was marked as outdated.

@nklaassen
Copy link
Copy Markdown
Contributor Author

Oh, one thing I forgot to include; if this requires Teleport Enterprise, that should be stated.

Added the license a a pre-req and explicitly mentioned that you should follow the Enterprise instructions of the Operator guide.

Thanks for the review!

@nklaassen nklaassen requested a review from alexfornuto April 21, 2023 21:01
@nklaassen nklaassen added this pull request to the merge queue Apr 25, 2023
Merged via the queue into master with commit 59ebccb Apr 25, 2023
@nklaassen nklaassen deleted the nklaassen/lr-operator-docs branch April 25, 2023 17:10
@public-teleport-github-review-bot
Copy link
Copy Markdown

@nklaassen See the table below for backport results.

Branch Result
branch/v12 Create PR
branch/v13 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants