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

Update README to refer to credentials.toml #331

Merged
merged 3 commits into from
Aug 14, 2024
Merged

Conversation

wfchandler
Copy link
Contributor

We no longer use hosts.toml. Update README to use the new file.

We no longer use `hosts.toml`. Update README to use the new file.
Copy link
Collaborator

@karencfv karencfv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch! Thanks @wfchandler 🙇‍♀️

README.md Outdated
@@ -15,7 +15,7 @@ To generate a token, follow these steps:
- Make sure you have installed the Oxide CLI
- Log in via the Oxide console.
- Run `oxide auth login --host <host>`
- Run `oxide auth status --host <host> --show-token` to retrieve the token (host and credential information is saved in `$HOME/.config/oxide/hosts.toml`).
- Run `oxide auth status --host <host> --show-token` to retrieve the token (host and credential information is saved in `$HOME/.config/oxide/credentials.toml`).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, I think the --host and --show token flags were removed from the oxide auth status command. Perhaps this sentence can be changed to tell the users that the tokens can be found in $HOME/.config/oxide/credentials.toml instead?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed; @karencfv what about if I implement oxidecomputer/oxide.rs#596 and we change the instructions to be oxide --profile foo env terraform plan or whatever -- that's kind of what I had in mind for that, but I wanted to validate that we think that's the right approach before going that way.

Copy link
Collaborator

@karencfv karencfv Aug 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ahl!

On the terraform side I was thinking about adding a profile argument to the provider block (#334) like this:

provider "oxide" {
  profile = "prod"
}

But it would also be really useful to have the command you mention too! I can see it being very practical for people wanting to apply the same terraform plan on several silos without having to go and manually edit the tf files.

So, yes. If you have the time, it'd be really nice to have that command in addition to what I'm planning on the TF side!

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might have my bit set the wrong way here, but I don't think this should be the domain of the terraform provider? That might be wrong or inconsistent (in that the Rust SDK is profile-aware), but my inclination is that I wouldn't ever put a profile name into a tf config: I'm probably going to check in the tf config to a git repo and I don't think I'd want everyone to be required to have the same profile name. What do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this conversation over to #334 ! I'll respond there to have a better record of this discussion :)

`oxide auth status --show-token` no longer exists.
@wfchandler
Copy link
Contributor Author

Thanks @karencfv, I've updated to remove the reference to --show-token.

Copy link
Collaborator

@karencfv karencfv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix!

@wfchandler wfchandler merged commit 84308fa into main Aug 14, 2024
1 check passed
@karencfv karencfv deleted the wc/credentials-update branch August 14, 2024 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants