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

Improve documentation for installing provider #52

Open
antevens opened this issue Apr 5, 2022 · 4 comments
Open

Improve documentation for installing provider #52

antevens opened this issue Apr 5, 2022 · 4 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@antevens
Copy link

antevens commented Apr 5, 2022

I think it might be very useful to improve the installation documentation for this provider (and possibly other community providers) to clarify which image tags to use when installing.

This might seem obvious to more experienced users but all the official Crossplane docs use either main or master tags for provider versions while provider-digitalocean seems to require v0.1.0 at the moment.

Perhaps a list of most current provider versions along with a standard "one-liner" which would pick the latest and use it without using latest/main/master might be even better?

@antevens antevens changed the title Improvde documentation for installing provider Improve documentation for installing provider Apr 5, 2022
@ADustyOldMuffin
Copy link
Contributor

Hello thanks for the issue!

We should be following the standard practice, and so the image should be tagged with latest. I'll check it out, and see how we can fix this!

@ADustyOldMuffin ADustyOldMuffin added bug Something isn't working documentation Improvements or additions to documentation labels Apr 5, 2022
@ADustyOldMuffin
Copy link
Contributor

So I believe this should be fixed with #53 and we should start publishing a docker image with the tag main. A downside is I'm going to wait until 0.2.0 for this as it'll require a release to kick in.

In the meantime, we do have several PRs for updating documentation and I'd welcome any others to update the docs for installing as I do agree it's a bit of a gray area for Crossplane in general.

@antevens
Copy link
Author

antevens commented Apr 6, 2022

Thanks!

I'm currently working on a toolchain that bootstraps a Digital Ocean k8s cluster with Autopilot + ArgoCD to deploy Crossplane, External-DNS, External-Secrets, Teleport and more to spin up k8s clusters on demand using only declarative git-ops methods.

Once I have a fully working toolchain I'll try to make a blog post from my notes and public git repos and make PR/MRs for the docs.

@ADustyOldMuffin
Copy link
Contributor

Sounds awesome! If you have any question please let me know, and I'd love to read any blog post you make.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants