diff --git a/docs/canonicalk8s/index.md b/docs/canonicalk8s/index.md index 066cf65a9..ebe25f04b 100644 --- a/docs/canonicalk8s/index.md +++ b/docs/canonicalk8s/index.md @@ -21,7 +21,7 @@ Home :maxdepth: 6 src/about.md -Choose an installation method +Choose an installation method Deploy from Snap package Deploy with Juju Deploy with Cluster API diff --git a/docs/src/capi/explanation/index.md b/docs/src/capi/explanation/index.md index d4ad076be..7579ef258 100644 --- a/docs/src/capi/explanation/index.md +++ b/docs/src/capi/explanation/index.md @@ -14,6 +14,7 @@ Overview :glob: about +installation-methods.md security capi-ck8s.md in-place-upgrades.md diff --git a/docs/src/capi/explanation/installation-methods.md b/docs/src/capi/explanation/installation-methods.md new file mode 100644 index 000000000..f98c2a69c --- /dev/null +++ b/docs/src/capi/explanation/installation-methods.md @@ -0,0 +1,2 @@ +```{include} ../../snap/explanation/installation-methods.md +``` diff --git a/docs/src/charm/explanation/index.md b/docs/src/charm/explanation/index.md index 9b4652cf2..660f34826 100644 --- a/docs/src/charm/explanation/index.md +++ b/docs/src/charm/explanation/index.md @@ -12,6 +12,7 @@ Overview ```{toctree} :titlesonly: about +installation-methods.md channels security ``` diff --git a/docs/src/charm/explanation/installation-methods.md b/docs/src/charm/explanation/installation-methods.md new file mode 100644 index 000000000..f98c2a69c --- /dev/null +++ b/docs/src/charm/explanation/installation-methods.md @@ -0,0 +1,2 @@ +```{include} ../../snap/explanation/installation-methods.md +``` diff --git a/docs/src/snap/explanation/installation-methods.md b/docs/src/snap/explanation/installation-methods.md index 4bd36f16c..a7f8a71c8 100644 --- a/docs/src/snap/explanation/installation-methods.md +++ b/docs/src/snap/explanation/installation-methods.md @@ -14,14 +14,14 @@ The {{ product }} snap is a self-contained, simple to install package. It can be installed on any Linux distribution that supports the [snapd] service, such as [Ubuntu]. If you're using a non-Linux system, we recommend creating virtual -machines using [Multipass] or [Lxd]. [Snaps] come with the advantage of +machines using [Multipass] or [LXD]. [Snaps] come with the advantage of automatic and atomic updates making it easy for users to install, maintain and update their software. If you are looking for a straightforward way to get started with {{ product }}, -and you don't intend to grow your cluster beyond a single node, installing -{{ product }} using the snap is the recommended installation method. Follow the -[getting-started guide] to install {{ product }} using the snap. +and your cluster will not grow beyond a few nodes, using the snap is +the recommended installation method. Follow the [getting-started guide] to +install {{ product }} using the snap. ## Juju @@ -29,14 +29,14 @@ and you don't intend to grow your cluster beyond a single node, installing deploy, configure, scale and operate {{ product }} on any infrastructure. Juju uses charms which are encapsulated reusable software packages to define how applications are deployed and related to each other. At its core, {{ product }} -comprises two Juju charms: a control plane charm and a worker charm. +comprises of two Juju charms: a [control plane charm] and a [worker charm]. Additionally, the Juju charm ecosystem provides further integrations, for example an observability stack. If you are looking to deploy {{ product }} in a public/private cloud -environment, on metal or in VMs you can take advantage of Juju's powerful -lifecycle management. Get started with a simple deployment of the -{{ product }}'s charms using the [juju-cli guide] or leverage +environment, on metal, in VMs or on your local machine you can take advantage of +Juju's powerful lifecycle management. Get started with a simple deployment of +the {{ product }}'s charms using the [juju-cli guide] or leverage [Terraform's Juju provider] by following the [installing-with-terraform] guide. @@ -46,22 +46,23 @@ guide. creating, configuring, and managing multiple Kubernetes clusters. If you plan to deploy and operate a large deployment with multiple -Kubernetes clusters, you can use the {{ product }}'s CAPI providers for AWS and -[MAAS]. Follow the [cluster-provisioning-with-CAPI guide] to deploy and operate -{{ product }} with the help of the CAPI providers. +Kubernetes clusters, you can use the {{ product }}'s CAPI providers. Follow the +[cluster-provisioning-with-CAPI guide] to deploy and operate {{ product }} with +the help of the CAPI providers. [Ubuntu]: https://help.ubuntu.com/ [Snaps]: https://snapcraft.io/docs [snapd]: https://snapcraft.io/docs/installing-snapd -[Terraform's Juju provider]: https://github.com/juju/terraform-provider-juju/ [Multipass]: https://canonical.com/multipass -[Lxd]: https://canonical.com/lxd +[LXD]: https://canonical.com/lxd +[Juju]: https://juju.is [juju-cli guide]: /src/charm/tutorial/getting-started.md +[control plane charm]: https://charmhub.io/k8s +[worker charm]: https://charmhub.io/k8s-worker [getting-started guide]: /src/snap/tutorial/getting-started.md +[Terraform's Juju provider]: https://github.com/juju/terraform-provider-juju/ [installing-with-terraform]: /src/charm/howto/install-terraform.md [cluster-provisioning-with-CAPI guide]: src/capi/tutorial/getting-started.md -[Juju]: https://juju.is [Cluster API]: https://cluster-api.sigs.k8s.io/ -[MAAS]: https://maas.io/ \ No newline at end of file