-
Notifications
You must be signed in to change notification settings - Fork 141
Add a quickstart for AlibabaCloud Provider with Crossplane #937
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: master
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for crossplane failed. Why did it fail? →
|
❌ Deploy Preview for crossplane failed. Why did it fail? →
|
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.
Thanks for making this contribution and continuing to support your provider @xiaozhu36! that's great to see this continued effort and commitment 😉
Let's fix this error to get the changes deploying to the preview site where they will be easier to review in their rendered form.
to Alibaba Cloud. | ||
* an Alibaba Cloud account with permissions to create an ECS instance, VPC, VSwitch and SecurityGroup. | ||
|
||
{{<expand "Skip part 1 and just get started" >}} |
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.
looks like there is an error on this line causing the build/deployment to the preview site to fail:
11:33:27 AM: Error: error building site: assemble: "/opt/build/repo/content/master/getting-started/provider-alibabacloud-part-2.md:25:1": failed to extract shortcode: shortcode "expand" must be closed or self-closed
This section of the contributing guide should help: https://docs.crossplane.io/contribute/features/#hide-long-outputs
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.
Thanks for your feedback. I have fixed it.
Signed-off-by: guimin.hgm <[email protected]>
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.
Looks good.
Nit: would be excellent to also show how to set up OIDC in addition to static credentials.
{{< /editCode >}} | ||
Save this text file as `alibabacloud-credential.yaml`. | ||
|
||
## Create a Kubernetes secret with the Alibaba Cloud credentials |
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.
It would be excellent if we could also show an example for OIDC setup with AlibabaCloud.
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.
to keep these consistent and streamlined in the quick starts, i'd recommend not bringing in OIDC into scope for this guide. That feels like advanced configuration that is better documented in the provider itself. These quick starts are intended to get people going as easily as possible. For example, the AWS provider quick start uses static creds and just links out to the AWS documentation - that feels more appropriate for a quick start.
All the checks seem to be stuck not running, even after I approved the workflows to run. I'm going to close this PR and re-open to try to get them unstuck 🙏 |
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.
It looks like the build of the docs site with these changes is still failing: https://app.netlify.com/projects/crossplane/deploys/68499ae0caf0819b0d6540e5
I can reproduce this locally too with hugo server
as describe in the contributing guide:
❯ hugo server
Watching for changes in /Users/jared/dev/go/src/github.com/crossplane/docs/{content,package.json,postcss.config.js,static,themes}
Watching for config changes in /Users/jared/dev/go/src/github.com/crossplane/docs/config.yaml
Start building sites …
hugo v0.137.0-59c115813595cba1b1c0e70b867e734992648d1b+extended darwin/arm64 BuildDate=2024-11-04T16:04:06Z VendorInfo=gohugoio
Built in 216 ms
Error: error building site: process: readAndProcessContent: "/Users/jared/dev/go/src/github.com/crossplane/docs/content/master/getting-started/provider-alibabacloud.md:45:16": failed to extract shortcode: shortcode "hover" must be closed or self-closed
So it's another shortcode tag that isn't closed. Could you iterate on cleaning these up until you get a successful hugo server
run? Thank you! 🙏
No description provided.