examples icon indicating copy to clipboard operation
examples copied to clipboard

Not a great experience w/ EKS example and badges

Open joeduffy opened this issue 7 years ago • 2 comments
trafficstars

I was excited to try out the new badge support for the https://github.com/pulumi/examples/tree/master/aws-ts-eks example. Sadly, it failed promptly with

    error: Could not find aws-iam-authenticator for EKS. See https://github.com/pulumi/eks#installing for installation instructions.
    error: an unhandled error occurred: Program exited with non-zero exit code: 1

I understand it's too difficult/brittle to attempt to install the aws-iam-authenticator package automatically. But it would be nice if the template page somehow told me this. And, after failing to update as part of a new, I think we should say something like "after fixing these problems, rerun pulumi up to complete this update."

joeduffy avatar Nov 10 '18 18:11 joeduffy

@joeduffy @justinvp Given the age of this issue, is there any action still needed here?

scottslowe avatar Nov 03 '22 18:11 scottslowe

@scottslowe, it's likely still relevant. I haven't tried it, but this is referring to using the "Deploy with Pulumi" button in the https://github.com/pulumi/examples/tree/master/aws-ts-eks example README.

I suspect this is still an issue when doing that without having the pre-reqs installed (in this case aws-iam-authenticator).

For this particular case, we may be able to address it in the same place we're emitting the "Could not find aws-iam-authenticator for EKS" error, by also including a note similar to Joe's suggestion on re-running pulumi up.

But we may also want to think of a better way to handle templates with prereqs like this more holistically, like having a way to specify a prereq message for a template, and if there is a failure, show the message along with the note about re-running pulumi up.

Note that we already support a quickstart property for templates, which is an optional message to be displayed after the project is created from the template. Perhaps that could be used in this case to have a message about the required aws-iam-authenticator. Might be worth seeing what the experience is like using this existing capability.

justinvp avatar Nov 03 '22 23:11 justinvp