From 8ddd9dc9657a4d0f7e81eededa837f4d3ef849ed Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Fri, 25 Oct 2024 02:51:44 -0400 Subject: [PATCH] Move the provisioner guide --- docs/architecture/cluster-architecture.md | 4 ++-- docs/deployment/getting-started.md | 2 +- docs/{manuals => deployment}/provisioner.md | 0 mkdocs.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) rename docs/{manuals => deployment}/provisioner.md (100%) diff --git a/docs/architecture/cluster-architecture.md b/docs/architecture/cluster-architecture.md index 6b39aea..48b2888 100644 --- a/docs/architecture/cluster-architecture.md +++ b/docs/architecture/cluster-architecture.md @@ -92,7 +92,7 @@ The Zookeeper database runs on the coordinator nodes, and requires a majority qu ### Patroni/PostgreSQL -PVC uses the Patroni PostgreSQL cluster manager to store relational data for use by the [Provisioner subsystem](../manuals/provisioner.md) and managed network DNS aggregation. +PVC uses the Patroni PostgreSQL cluster manager to store relational data for use by the [Provisioner subsystem](../deployment/provisioner) and managed network DNS aggregation. The Patroni system runs on the coordinator nodes, with the primary coordinator taking on the "leader" role (read-write) and all others taking on the "follower" role (read-only). Patroni leverages Zookeeper to handle state, and is thus dependent on Zookeeper to function. @@ -158,7 +158,7 @@ PVC can provide services to clients in this network via the DNSMasq subsystem, i **NOTE:** Be aware of the potential for "tromboning" when routing between managed networks. All traffic to and from a managed network will flow out the primary coordinator. Thus, if there is a large amount of inter-network traffic between two managed networks, all this traffic will traverse the primary coordinator, introducing a potential bottleneck. To avoid this, keep the amount of inter-network routing between managed networks or between managed networks and the outside world to a minimum. -One major purpose of managed networks is to provide a bootstrapping mechanism for new VMs deployed using the [PVC provisioner](../manuals/provisioner.md) with CloudInit metadata services (see that documentation for details). Such deployments will require at least one managed network to provide access to the CloudInit metadata system. +One major purpose of managed networks is to provide a bootstrapping mechanism for new VMs deployed using the [PVC provisioner](../deployment/provisioner) with CloudInit metadata services (see that documentation for details). Such deployments will require at least one managed network to provide access to the CloudInit metadata system. #### Bridged diff --git a/docs/deployment/getting-started.md b/docs/deployment/getting-started.md index 768c339..7752480 100644 --- a/docs/deployment/getting-started.md +++ b/docs/deployment/getting-started.md @@ -874,4 +874,4 @@ If you want to add additional non-coordinator nodes, you can do so now. Run thro ## Next steps -For the next steps, see the [Provisioner manual](/manuals/provisioner) for details on how to use the PVC provisioner to create new Virtual Machines, as well as the [CLI manual](/manuals/cli) and [API manual](/manuals/api) for details on day-to-day usage of PVC. +For the next steps, see the [Provisioner Guide](/deployment/provisioner) for details on how to use the PVC provisioner to create new Virtual Machines, as well as the [CLI manual](/manuals/cli) and [API manual](/manuals/api) for details on day-to-day usage of PVC. diff --git a/docs/manuals/provisioner.md b/docs/deployment/provisioner.md similarity index 100% rename from docs/manuals/provisioner.md rename to docs/deployment/provisioner.md diff --git a/mkdocs.yml b/mkdocs.yml index a0abc2e..ec0eac9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,11 +19,11 @@ nav: - 'Georedundancy': 'architecture/georedundancy.md' - 'Deployment': - 'Getting Started Guide': 'deployment/getting-started.md' + - 'Provisioner Guide': 'deployment/provisioner.md' - 'Manuals': - 'PVC CLI': 'manuals/cli.md' - 'PVC HTTP API': 'manuals/api.md' - 'PVC Node Daemon': 'manuals/daemon.md' - - 'PVC Provisioner': 'manuals/provisioner.md' - 'PVC Node Health Plugins': 'manuals/health-plugins.md' - 'API': - 'API Reference': 'manuals/api-reference.html'