docs: update CA rotation docs #49468
Conversation
nklaassen
added
no-changelog
github-actions
bot
requested review from
mmcallister,
ptgott,
r0mant,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-f3a9rw882-goteleport.vercel.app/docs |
|
|
||
| CA rotations can be **manual** or **semi-automatic**. In manual mode, admins | ||
| must instruct the Teleport Auth Service to advance from one phase to the next. | ||
| Between phases, admins can prepare their infrastructure to adjust to each | ||
| change. In semi-automatic mode, the Teleport Auth Service cycles through each | ||
| phase automatically, with a grace period between each phase. | ||
|
|
||
| In 17.1.0+ `tctl auth rotate` (with no arguments) starts an interactive |
There was a problem hiding this comment.
In this change, we mention tctl auth rotate after the manual and semi-automatic options. Would it make sense to structure the guide around the wizard instead, and leave the documentation of the arguments for our reference guides (i.e., this guide would be the fast path)? Otherwise, while the argumentless form of tctl auth rotate is a simplification, the documentation actually becomes a little more complex.
There was a problem hiding this comment.
I can see some benefits to pushing the interactive command, though I worry that relying only on arguments in the reference guides might leave too much as an exercise to the reader.
There was a problem hiding this comment.
@ptgott i haven't been finding the time to come back to this and rewrite with an interactive-first guide. If what he have here is a net improvement do you think we can merge as-is?
There was a problem hiding this comment.
Friendly ping @ptgott.
There was a problem hiding this comment.
To expedite this, I would open a separate PR containing only the new tctl auth rotate changes. That way, we can finalize the wording of the other changes and decide on a structure for this guide that is easier to make sense of.
|
🤖 Vercel preview here: https://docs-e5day2a2e-goteleport.vercel.app/docs |
nklaassen
force-pushed
the
nklaassen/rotate-docs
branch
from
c713ea4 to
07e58cb
Compare
nklaassen
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
|
Amplify deployment status
|
nklaassen
force-pushed
the
nklaassen/rotate-docs
branch
from
07e58cb to
9be9163
Compare
nklaassen
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
|
I decided to remove most of the unrelated changes from this PR and just include a couple mentions of the new interactive CA rotation |
public-teleport-github-review-bot
bot
removed the request for review
from r0mant
public-teleport-github-review-bot
bot
removed request for
mmcallister,
zmb3 and
xinding33
|
@nklaassen See the table below for backport results.
|
This PR updates the CA rotation to mention the new interactive
tctl auth rotate(#49171).