-
Notifications
You must be signed in to change notification settings - Fork 7
docs: nautobot token creation flow #1312
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
base: main
Are you sure you want to change the base?
Conversation
|
||
1. Service account details are stored in **Vault (PasswordSafe)**. | ||
2. A **Kubernetes Secret** is generated in the `nautobot` namespace. | ||
3. **Argo Events** detects the secret creation or update based on the [label](https://github.com/rackerlabs/understack/blob/main/workflows/nautobot/eventsources/k8s-secret-nautobot-token.yaml#L19). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's worth mentioning what the label explicitly here to save the user a need to visit the link
3. **Argo Events** detects the secret creation or update based on the [label](https://github.com/rackerlabs/understack/blob/main/workflows/nautobot/eventsources/k8s-secret-nautobot-token.yaml#L19). | |
3. **Argo Events** detects the secret creation or update based on the [`token/type=nautobot` label](https://github.com/rackerlabs/understack/blob/main/workflows/nautobot/eventsources/k8s-secret-nautobot-token.yaml#L19). |
|
||
**High-level Flow:** | ||
|
||
1. Service account details are stored in **Vault (PasswordSafe)**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which PasswordSafe? Where is this configured? How can operators figure out which project to add the service accounts to? What is the syntax?
Consider adding some generic example of a fake credential - I think that would help
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will be adding syntax but shall I add password safe details too ? since this repo is public
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. It should have some generic backend.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shall I remove mention of Passwordsafe
from this doc ?
## Usage Flow Summary | ||
|
||
1. Add or update service account credentials in **Vault / PasswordSafe**. | ||
2. Vault sync process generates a **Kubernetes Secret** in `nautobot` namespace. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does the sync process remove the secrets that have been removed from Vault/PasswordSafe too?
It's fine if it doesn't, but we probably should mention it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we do not remove. updated it in doc.
f7c9477
to
d5d1185
Compare
No description provided.