Move install into get started

Move upgrade and uninstall into guides

Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
Nic Cope 2025-03-26 12:05:02 -07:00
parent b8b91d1a9b
commit 659082698e
13 changed files with 22 additions and 46 deletions

View File

@ -41,7 +41,7 @@ plane** to check, report and act on any resource, anywhere.
# Get started # Get started
* [Install Crossplane]({{<ref "software/install">}}) in your Kubernetes cluster * [Install Crossplane]({{<ref "get-started/install">}}) in your Kubernetes cluster
* Learn more about how Crossplane works in the * Learn more about how Crossplane works in the
[Crossplane introduction]({{<ref "get-started/introduction" >}}) [Crossplane introduction]({{<ref "get-started/introduction" >}})
* Join the [Crossplane Slack](https://slack.crossplane.io/) and start a * Join the [Crossplane Slack](https://slack.crossplane.io/) and start a

View File

@ -452,4 +452,4 @@ vpc-staging True myvpcs.aws.example.upbound.io-727b3c8 Automatic map[c
[composition type]: {{<ref "../../master/concepts/compositions" >}} [composition type]: {{<ref "../../master/concepts/compositions" >}}
[Compositions]: {{<ref "../../master/concepts/compositions" >}} [Compositions]: {{<ref "../../master/concepts/compositions" >}}
[canary]: https://martinfowler.com/bliki/CanaryRelease.html [canary]: https://martinfowler.com/bliki/CanaryRelease.html
[install guide]: {{<ref "../../master/software/install" >}} [install guide]: {{<ref "../../master/get-started/install" >}}

View File

@ -298,11 +298,11 @@ that satisfies the constraints.
{{<hint "note" >}} {{<hint "note" >}}
This configuration requires the `--enable-dependency-version-upgrades` flag. This configuration requires the `--enable-dependency-version-upgrades` flag.
Please check the Please check the
[configuration options]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}) [configuration options]({{<ref "../get-started/install#customize-the-crossplane-helm-chart">}})
and and
[feature flags]({{<ref "../software/install#feature-flags">}}) [feature flags]({{<ref "../get-started/install#feature-flags">}})
are available in the are available in the
[Crossplane Install]({{<ref "../software/install">}}) [Crossplane Install]({{<ref "../get-started/install">}})
section for more details. section for more details.
{{</hint >}} {{</hint >}}

View File

@ -36,7 +36,7 @@ The core CRDs installed by the init container include:
{{< hint "note" >}} {{< hint "note" >}}
The [Install Crossplane]({{< ref "../software/install" >}}) section has more The [Install Crossplane]({{< ref "../get-started/install" >}}) section has more
information about customizing the Crossplane install. information about customizing the Crossplane install.
{{< /hint >}} {{< /hint >}}
@ -169,7 +169,7 @@ spec:
{{<hint "tip" >}} {{<hint "tip" >}}
The [Crossplane install guide]({{<ref "../software/install#feature-flags">}}) The [Crossplane install guide]({{<ref "../get-started/install#feature-flags">}})
describes enabling feature flags like describes enabling feature flags like
{{<hover label="deployment" line="12">}}--enable-realtime-compositions{{</hover>}} {{<hover label="deployment" line="12">}}--enable-realtime-compositions{{</hover>}}
with Helm. with Helm.
@ -222,7 +222,7 @@ file, setting `rbacManager.deploy` to `false`.
{{< hint "note" >}} {{< hint "note" >}}
Instructions for changing Crossplane pod settings during installation are in the Instructions for changing Crossplane pod settings during installation are in the
[Crossplane Install]({{<ref "../software/install">}}) section. [Crossplane Install]({{<ref "../get-started/install">}}) section.
{{< /hint >}} {{< /hint >}}
<!-- vale Microsoft.HeadingAcronyms = NO --> <!-- vale Microsoft.HeadingAcronyms = NO -->
@ -335,17 +335,17 @@ Change Crossplane pod settings either before installing Crossplane by editing
the Helm `values.yml` file or after installation by editing the `Deployment`. the Helm `values.yml` file or after installation by editing the `Deployment`.
The full list of The full list of
[configuration options]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}) [configuration options]({{<ref "../get-started/install#customize-the-crossplane-helm-chart">}})
and and
[feature flags]({{<ref "../software/install#feature-flags">}}) [feature flags]({{<ref "../get-started/install#feature-flags">}})
are available in the are available in the
[Crossplane Install]({{<ref "../software/install">}}) [Crossplane Install]({{<ref "../get-started/install">}})
section. section.
{{< hint "note" >}} {{< hint "note" >}}
Instructions for changing Crossplane pod settings during installation are in the Instructions for changing Crossplane pod settings during installation are in the
[Crossplane Install]({{<ref "../software/install">}}) section. [Crossplane Install]({{<ref "../get-started/install">}}) section.
{{< /hint >}} {{< /hint >}}
### Edit the deployment ### Edit the deployment
@ -391,4 +391,4 @@ The core Crossplane pod checks for configured environmental variables at startup
to change default settings. to change default settings.
The full list of configurable environmental variables are available in the The full list of configurable environmental variables are available in the
[Crossplane Install]({{<ref "../software/install">}}) section. [Crossplane Install]({{<ref "../get-started/install">}}) section.

View File

@ -325,11 +325,11 @@ that satisfies the constraints.
{{<hint "note" >}} {{<hint "note" >}}
This configuration requires the `--enable-dependency-version-upgrades` flag. This configuration requires the `--enable-dependency-version-upgrades` flag.
Please check the Please check the
[configuration options]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}) [configuration options]({{<ref "../get-started/install#customize-the-crossplane-helm-chart">}})
and and
[feature flags]({{<ref "../software/install#feature-flags">}}) [feature flags]({{<ref "../get-started/install#feature-flags">}})
are available in the are available in the
[Crossplane Install]({{<ref "../software/install">}}) [Crossplane Install]({{<ref "../get-started/install">}})
section for more details. section for more details.
{{</hint >}} {{</hint >}}

View File

@ -47,7 +47,7 @@ spec:
{{<hint "tip" >}} {{<hint "tip" >}}
The [Crossplane install guide]({{<ref "../software/install#feature-flags">}}) The [Crossplane install guide]({{<ref "../get-started/install#feature-flags">}})
describes enabling feature flags like describes enabling feature flags like
{{<hover label="deployment" line="12">}}\-\-enable-usages{{</hover>}} {{<hover label="deployment" line="12">}}\-\-enable-usages{{</hover>}}
with Helm. with Helm.

View File

@ -3,13 +3,3 @@ title: Get Started
weight: 4 weight: 4
description: Get started with Crossplane. description: Get started with Crossplane.
--- ---
{{<img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}}
## Hands-on
TODO
## Install
Ready to get started? [Install Crossplane]({{<ref "../software/install" >}}) in a Kubernetes cluster.

View File

@ -1,6 +1,6 @@
--- ---
title: Crossplane Introduction title: Crossplane Introduction
weight: 2 weight: 1000
--- ---
Crossplane connects your Kubernetes cluster to external, Crossplane connects your Kubernetes cluster to external,

View File

@ -11,7 +11,7 @@ registries, it must be configured to trust the CA and Intermediate certs.
Crossplane needs to be installed via the Helm chart with the Crossplane needs to be installed via the Helm chart with the
`registryCaBundleConfig.name` and `registryCaBundleConfig.key` parameters `registryCaBundleConfig.name` and `registryCaBundleConfig.key` parameters
defined. See [Install Crossplane]({{<ref "../../master/software/install" >}}). defined. See [Install Crossplane]({{<ref "../get-started/install" >}}).
## Configure ## Configure

View File

@ -1,6 +1,6 @@
--- ---
title: Uninstall Crossplane title: Uninstall Crossplane
weight: 300 weight: 500
--- ---
{{<hint "warning" >}} {{<hint "warning" >}}

View File

@ -1,6 +1,6 @@
--- ---
title: Upgrade Crossplane title: Upgrade Crossplane
weight: 200 weight: 400
--- ---
The recommended upgrade method for an existing Crossplane install is to use The recommended upgrade method for an existing Crossplane install is to use
@ -51,7 +51,7 @@ For example, in v1.20.0 Crossplane changed the default image registry from
before v1.20.0 updates the default package registry. before v1.20.0 updates the default package registry.
Override new defaults by Override new defaults by
[customizing the Helm chart]({{<ref "install#customize-the-crossplane-helm-chart" >}}) [customizing the Helm chart]({{<ref "../get-started/install#customize-the-crossplane-helm-chart" >}})
with the upgrade command. with the upgrade command.
For example, to maintain the original image registry use For example, to maintain the original image registry use

View File

@ -1,14 +0,0 @@
---
title: Install, Upgrade and Uninstall
weight: 10
description: Manage Crossplane installations
---
## [Install Crossplane](install/)
How to install and customize Crossplane in an existing Kubernetes cluster.
## [Upgrade Crossplane](upgrade/)
How to upgrade Crossplane to newer versions of the software.
## [Uninstall Crossplane](uninstall/)
How to remove Crossplane from a Kubernetes cluster.