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

docs: document Crossplane PAD-82 #2713

Merged
merged 14 commits into from
May 7, 2024
Merged

docs: document Crossplane PAD-82 #2713

merged 14 commits into from
May 7, 2024

Conversation

caroldelwing
Copy link
Contributor

@caroldelwing caroldelwing commented Apr 29, 2024

Describe the Change

This PR documents the Palette Crossplane provider. The following changes were implemented:

  • A new Automation section was created, and the Palette CLI is now part of this section.
  • A new Crossplane reference page was created.
  • Three guides were created on deploying a host cluster using Crossplane to AWS, GCP, and Azure.
  • Added a reference to the Deploy a Cluster tutorial on the Terraform reference page.

Note: this PR will only be merged after the PAD-233 ticket is solved and the GCP workflow is tested.

Changed Pages

💻 Automation
💻 Terraform (Only added a reference to the Deploy a Cluster tutorial under the Usage section)
💻 Crossplane
💻 Deploy an AWS Cluster with Crossplane
💻 Deploy an Azure Cluster with Crossplane
💻 Deploy a GCP Cluster with Crossplane

Jira Tickets

🎫 PAD-82

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

Copy link

netlify bot commented Apr 29, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 71d2d79
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/663a6d28820b7d0008c3ad97
😎 Deploy Preview https://deploy-preview-2713--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@caroldelwing caroldelwing added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 labels Apr 29, 2024
@caroldelwing caroldelwing marked this pull request as ready for review April 29, 2024 21:08
@caroldelwing caroldelwing requested a review from a team as a code owner April 29, 2024 21:08
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md|194 col 22| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md|289 col 65| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'sysctl -p' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md|463 col 31| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md|478 col 99| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'profile -o' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md|487 col 5| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'curl -L -X' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|10 col 25| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|12 col 12| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|35 col 34| [Vale.Spelling] Did you really mean 'Nano'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|37 col 31| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|52 col 19| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|52 col 59| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|69 col 17| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|91 col 10| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|97 col 76| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|115 col 52| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|115 col 73| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|115 col 101| [Vale.Spelling] Did you really mean 'CRDs'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|166 col 98| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|195 col 22| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|291 col 65| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'sysctl -p' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|555 col 31| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|570 col 97| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'profile -o' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md|579 col 5| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'curl -L -X' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|10 col 25| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|12 col 12| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|34 col 34| [Vale.Spelling] Did you really mean 'Nano'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|36 col 30| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|51 col 19| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|51 col 59| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|68 col 17| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|90 col 10| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|96 col 76| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|114 col 52| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|114 col 73| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|114 col 101| [Vale.Spelling] Did you really mean 'CRDs'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|165 col 98| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|194 col 22| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|283 col 65| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'sysctl -p' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|367 col 31| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|382 col 97| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'profile -o' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|391 col 5| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'curl -L -X' with the corresponding long form flag.
docs/docs-content/release-notes.md|86 col 30| [spectrocloud.condescending] Using 'clearly' may come across as condescending.
docs/docs-content/release-notes.md|86 col 30| [alex.Condescending] Using 'clearly' may come across as condescending.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md|137 col 7| [Vale.Terms] Use 'airgap' instead of 'Airgap'.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|90 col 10| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|96 col 76| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|114 col 52| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|114 col 73| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|114 col 101| [Vale.Spelling] Did you really mean 'CRDs'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|165 col 98| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|194 col 22| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|283 col 65| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'sysctl -p' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|367 col 31| [Vale.Spelling] Did you really mean 'Crossplane'?
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|382 col 97| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'profile -o' with the corresponding long form flag.
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md|391 col 5| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'curl -L -X' with the corresponding long form flag.
docs/docs-content/release-notes.md|86 col 30| [alex.Condescending] Using 'clearly' may come across as condescending.
docs/docs-content/release-notes.md|86 col 30| [spectrocloud.condescending] Using 'clearly' may come across as condescending.

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

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

Great work @caroldelwing , thank you for researching this workflow and putting it all together. I left you some minor feedback in the AWS tutorial that applies to all three. Just minor nitpicks.

Copy link
Contributor

@yuliiiah yuliiiah left a comment

Choose a reason for hiding this comment

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

Approving with some comments and suggestions ✨ Great job!

@caroldelwing caroldelwing merged commit dc48ced into master May 7, 2024
17 checks passed
@caroldelwing caroldelwing deleted the crossplane-doc branch May 7, 2024 18:41
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request May 7, 2024
* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
(cherry picked from commit dc48ced)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-0:
- docs: updated URLs to use file path context
version-3-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-3-4:
- chore: DOC-1148 fix missing trailing slash (#2656)
- docs: DOC-448 VMware Refactor (#2540)
- docs: DOC-936 DOC-916 DOC-928 DOC-929 zure Permissons (#2077)
- docs: set toc_max_heading_level to default value 3 for all docs DOC-938 (#1947)
- Refactor/restructure cluster & app profiles sections (#1551)
- docs: refactor for self-hosted Palette DOC-465 (#1597)
- chore: released docs versioning
version-4-1 Backport failed because of merge conflicts
version-4-2 Backport failed because of merge conflicts
version-4-3

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 2713

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

vault-token-factory-spectrocloud bot added a commit that referenced this pull request May 7, 2024
* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
(cherry picked from commit dc48ced)

Co-authored-by: caroldelwing <[email protected]>
caroldelwing added a commit that referenced this pull request May 7, 2024
* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request May 7, 2024
* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request May 7, 2024
* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request May 8, 2024
* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request May 8, 2024
* docs: document Crossplane PAD-82 (#2713)

* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: fix broken link

* docs: remove fips-validate redirect path

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request May 8, 2024
* docs: document Crossplane PAD-82 (#2713)

* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: remove fips-validate redirect path

* docs: remove invalid redirect path

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request May 8, 2024
* docs: document Crossplane PAD-82 (#2713)

* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: fix broken links

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
caroldelwing added a commit that referenced this pull request May 8, 2024
* docs: create new automation section, crossplane page, crossplane aws guide

* docs: add crossplane azure guide

* docs: add gcp crossplane guide, fix indentation

* docs: move palette cli under automation, fix broken links

* docs: fix more palette cli broken links

* docs: fix more broken links

* docs: add redirects, add crossplane to vale, apply vale and Tyler suggestions

* docs: address suggestions

* Apply suggestions from code review



* docs: apply more suggestions from review

* docs: more review suggestions

* docs: fix palette cli link

---------

Co-authored-by: Yuliia Horbenko <[email protected]>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.3.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants