-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[version-4-0] backport document Crossplane PR 2713 (#2791)
* 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]>
- Loading branch information
1 parent
180724f
commit 61737be
Showing
30 changed files
with
1,944 additions
and
132 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "position": 210 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| sidebar_label: "Automation" | ||
| title: "Automation" | ||
| description: "Learn how to use automation tools with Palette and Palette VerteX." | ||
| hide_table_of_contents: false | ||
| sidebar_position: 0 | ||
| sidebar_custom_props: | ||
| icon: "terminal" | ||
| tags: ["automation"] | ||
| --- | ||
|
|
||
| This section contains documentation and guides for tools essential in automating tasks with Palette: | ||
|
|
||
| - Palette CLI - Enables users to interact with Palette and create and manage resources, such as projects, virtual | ||
| clusters, and more. The Palette CLI is the primary method for installing a | ||
| [self-hosted Palette](../enterprise-version/enterprise-version.md) instance and deploying a | ||
| [Private Cloud Gateway](../clusters/pcg/pcg.md). | ||
|
|
||
| - Palette Terraform Provider - Allows users to use [Terraform](https://www.terraform.io) for automating the deployment | ||
| and management of Palette resources such as cluster profiles, cloud accounts, clusters, and more. | ||
|
|
||
| - Palette Crossplane Provider - It allows users to use [Crossplane](https://docs.crossplane.io/v1.15/) to provision and | ||
| manage Palette resources through standard Kubernetes APIs. | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Palette CLI](./palette-cli/palette-cli.md) | ||
| - [Palette Terraform Provider](./terraform/terraform.md) | ||
| - [Palette Crossplane Provider](./crossplane/crossplane.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "position": 30 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| sidebar_label: "Crossplane" | ||
| title: "Crossplane" | ||
| description: "Learn how to use Crossplane with Palette and Palette VerteX." | ||
| hide_table_of_contents: false | ||
| sidebar_position: 0 | ||
| tags: ["crossplane", "iac", "automation", "infrastructure as code"] | ||
| --- | ||
|
|
||
| Palette supports the open-source Cloud Native Computing Foundation (CNCF) project | ||
| [Crossplane](https://www.crossplane.io/). Crossplane transforms Kubernetes clusters into universal control planes, | ||
| extending the Kubernetes API and enabling infrastructure resource provisioning and management across major | ||
| infrastructure providers. | ||
|
|
||
| These resources, called | ||
| [Managed Resources (MR)](https://docs.crossplane.io/latest/concepts/managed-resources/#managed-resource-fields) within | ||
| the Crossplane environment, are essentially Kubernetes Custom Resource Definitions (CRDs) that represent infrastructure | ||
| resources as native Kubernetes objects. Because they are Kubernetes objects, you can interact with them using standard | ||
| commands like `kubectl describe`. When users create a managed resource, Crossplane interacts with the infrastructure | ||
| provider API to request the creation of the resource within the provider's environment. | ||
|
|
||
| ## Palette Provider | ||
|
|
||
| You can use the Palette Crossplane Provider to interact with the Palette API and create resources declaratively. | ||
|
|
||
| Refer to the [Palette Provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-palette/v0.12.0) | ||
| page for a complete list of managed resources and examples. | ||
|
|
||
| ## Get Started | ||
|
|
||
| For examples of end-to-end cluster provisioning with Crossplane, review the following guides: | ||
|
|
||
| - [Deploy an AWS IaaS Cluster with Crossplane](./deploy-cluster-aws-crossplane.md) | ||
| - [Deploy an Azure IaaS Cluster with Crossplane](./deploy-cluster-azure-crossplane.md) | ||
| - [Deploy a GCP IaaS Cluster with Crossplane](./deploy-cluster-gcp-crossplane.md) | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Crossplane Documentation](https://docs.crossplane.io/latest/) |
667 changes: 667 additions & 0 deletions
667
docs/docs-content/automation/crossplane/deploy-cluster-aws-crossplane.md
Large diffs are not rendered by default.
Oops, something went wrong.
579 changes: 579 additions & 0 deletions
579
docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md
Large diffs are not rendered by default.
Oops, something went wrong.
479 changes: 479 additions & 0 deletions
479
docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
docs/docs-content/automation/palette-cli/commands/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "position": 10 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "position": 20 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| sidebar_label: "Terraform" | ||
| title: "Terraform" | ||
| description: "Learn how to use Terraform with Palette and Palette VerteX." | ||
| hide_table_of_contents: false | ||
| sidebar_position: 0 | ||
| tags: ["terraform"] | ||
| --- | ||
|
|
||
| Palette supports the Infrastructure as Code (IaC) software tool, [Terraform](https://www.terraform.io/), to provide | ||
| consistent CLI workflow support to multiple cloud providers. | ||
|
|
||
| Terraform organizes cloud APIs into declarative configuration files, allowing users to define their infrastructure as | ||
| code. Terraform validates configuration files and checks whether the execution plan for a configuration matches | ||
| expectations before deployment, and applies the changes to managed resources accordingly. | ||
|
|
||
| ## Spectro Cloud Provider | ||
|
|
||
| Palette and Palette VerteX API can be used with the Spectro Cloud Terraform provider. The provider is available in the | ||
| HashiCorp Terraform registry as the | ||
| [Spectro Cloud Provider](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs). | ||
|
|
||
| ### Release Notes | ||
|
|
||
| Information about the latest changes in the Spectro Cloud provider can be found in the | ||
| [release notes](https://github.com/spectrocloud/terraform-provider-spectrocloud/releases). | ||
|
|
||
| ### Provider Documentation | ||
|
|
||
| Detailed documentation on supported data sources and resources are available in the Terraform Spectro Cloud Provider | ||
| [documentation](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs) page. | ||
|
|
||
| ### Modules | ||
|
|
||
| Two modules are available to help you provision Spectro Cloud infrastructure resources. | ||
|
|
||
| - [Palette Edge Native Terraform Module](https://registry.terraform.io/modules/spectrocloud/edge/spectrocloud/latest) | ||
| - [Spectro Cloud Terraform Modules](https://registry.terraform.io/modules/spectrocloud/modules/spectrocloud/latest) | ||
|
|
||
| Refer to the | ||
| [Spectro Cloud Modules](https://github.com/spectrocloud/terraform-spectrocloud-modules#module-resources--requirements) | ||
| README file to learn more about supported provider versions and other essential requirements. | ||
|
|
||
| ## Get Started | ||
|
|
||
| For an end-to-end cluster provisioning example, refer to the | ||
| [Deploy a Cluster](../../clusters/public-cloud/deploy-k8s-cluster.md) tutorial and the | ||
| [end-to-end examples](https://github.com/spectrocloud/terraform-provider-spectrocloud/tree/main/examples/e2e) available | ||
| in the Spectro Cloud Terraform Provider GitHub repository. | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Terraform Documentation](https://developer.hashicorp.com/terraform/docs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.