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

Correction for README.md #95

Open
jmcgnh opened this issue Apr 30, 2019 · 5 comments
Open

Correction for README.md #95

jmcgnh opened this issue Apr 30, 2019 · 5 comments

Comments

@jmcgnh
Copy link

jmcgnh commented Apr 30, 2019

Currently it reads

You must specify your Linode Personal Access Token. This may be found on the control panel within the my profile > API Keys section.

Which is a combination of misleading and inaccurate. The Personal Access Token is different from the API keys and neither can be "found" in the profile. They must be captured by the user when they are created and can't be retrieved later. And an API key is required for the Vagrantfile, not the Personal Access Token.

My suggested rewording is:

You must specify an API key. You can create a new one at My Profile >> API Keys in the Linode Manager dashboard or re-use one you created and recorded earlier.

@displague
Copy link
Owner

Instructions for any (every?) legacy APIv3 tool needs some doc enhancement since the default user interface has evolved into the Cloud manager (cloud.linode.com) which issues Access Tokens which are not compatible with the old API Keys.

The new Cloud manager offers Personal Access Tokens (Linode APIv4) at:

The legacy manager offers API Keys (Linode APIv3) at:

This Vagrant provider uses the legacy API keys (Linode APIv3).

Would you be interested in making a pull request to update the README?

@jmcgnh
Copy link
Author

jmcgnh commented Apr 30, 2019

Willing, but not sure I'm capable. I will give it a try when my internet gets fixed, but this will be my first pull request ever.

I was just reporting based on my experience getting the plugin to work for the first time and documenting what had been the biggest stumbling block I encountered: I got the access token as indicated in the README and tried to use it.

I was unaware of Linode's APIv3 to APIv4 transition.

I presume that there's a plan to migrate this plugin to APIv4 at some point.

@displague
Copy link
Owner

displague commented Apr 30, 2019

@ctreatma and I have that migration on our radar, @jmcgnh.

You can expect most all of the fields to change. While APIv4 has an improved interface and more consistent values, there is no direct mapping of the old APIv3 values to the new APIv4 values (specifically Distributions, Kernels, Datacenters, Plans).

If you want to start using APIv4 in your tooling now, you can take a look at our Terraform provider. I gave an example of how to move from a single node vagrant project to Terraform here:

#92 (comment)

More details about the Terraform provider (including links to Linode specific guides) are available here:

https://www.terraform.io/docs/providers/linode

@shannah
Copy link

shannah commented Mar 31, 2020

There doesn't seem to be a way to access the V3 API manager. I just get forwarded to the new one. So is it the case that Vagrant cannot be used with Linode now?

@displague
Copy link
Owner

displague commented Apr 29, 2021

@shannah APIv3 is still around and it includes a way to generate new keys:

You can see the documentation for this feature here:

curl 'https://api.linode.com/?api_action=api.spec' | jq '.DATA.METHODS["user.getapikey"]'

(The variables must be supplied in the query string 😢. There are restrictions preventing users from adopting the deprecated APIv3 too: "This user is not eligible to generate API keys".)

The old Linode CLI may even include a way to generate keys using this endpoint: linode account user getapikey.

To your greater point, I haven't used this project in a while. It's quite possible that the API requirements have changed and that even with an API key, this may not work.

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

No branches or pull requests

3 participants