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

move charm install files to charm/howto/install #955

Merged
merged 4 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/charm/howto/cos-lite.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ you can head over to the [COS Lite documentation][cos-lite-docs].

<!-- LINKS -->

[how-to-install]: ../howto/charm
[how-to-install]: ../howto/charm/install
[add-k8s]: https://juju.is/docs/juju/juju-add-k8s
[cos-lite-docs]: https://charmhub.io/topics/canonical-observability-stack
[juju-models]: https://juju.is/docs/juju/model
Expand Down
5 changes: 1 addition & 4 deletions docs/src/charm/howto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ Overview <self>
:glob:
:titlesonly:

charm
install-lxd
install-terraform
Install with custom configuration <install-custom>
install/index
Add worker nodes with custom configurations <custom-workers>
eaudetcobello marked this conversation as resolved.
Show resolved Hide resolved
openstack
Integrate with etcd <etcd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ Use `juju status` to watch these units approach the active/idle state.
<!-- LINKS -->

[Installing]: ./index
[channels]: ../explanation/channels
[channels]: ../../explanation/channels
[credentials]: https://juju.is/docs/juju/credentials
[juju]: https://juju.is/docs/juju/install-juju
[charm]: https://juju.is/docs/juju/charmed-operator
[localhost]: ../howto/install-lxd
[localhost]: install-lxd
20 changes: 20 additions & 0 deletions docs/src/charm/howto/install/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Installing {{product}}

```{toctree}
:hidden:
Install <self>
```

There's more than one way to install {{product}}. You'll find links to
the current How-to guides below.

```{toctree}
:glob:
:titlesonly:

Install from a charm <charm.md>
Install in LXD <install-lxd.md>
Install with Terraform <install-terraform.md>
Install with a custom configuration <install-custom.md>
Install with custom worker configuration <custom-workers.md>
```
6 changes: 3 additions & 3 deletions docs/src/snap/explanation/installation-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{ product }} can be installed in a variety of ways, depending on your needs and
preferences. All installation methods provide a fully functional cluster with
upstream Kubernetes and additional built-in features such as networking, ingress
and storage. Your choice may be influenced by the cluster size, the
and storage. Your choice may be influenced by the cluster size, the
environment you are deploying to, and the life cycle management tools that you
prefer to use. The following sections describe the different installation
methods:
Expand Down Expand Up @@ -43,7 +43,7 @@ guide.
## Cluster API (CAPI)

[Cluster API] is a Kubernetes sub-project that provides declarative APIs for
creating, configuring, and managing multiple Kubernetes clusters.
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. Follow the
Expand All @@ -63,6 +63,6 @@ the help of the CAPI providers.
[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
[installing-with-terraform]: /src/charm/howto/install/install-terraform
[CAPI guide]: /src/capi/tutorial/getting-started.md
[Cluster API]: https://cluster-api.sigs.k8s.io/
Loading