Skip to content

Commit

Permalink
content: update titles in whole nav bar
Browse files Browse the repository at this point in the history
  • Loading branch information
nickcernera committed Feb 20, 2025
1 parent 8b12e86 commit 3582514
Show file tree
Hide file tree
Showing 63 changed files with 233 additions and 245 deletions.
2 changes: 1 addition & 1 deletion pages-archive/deployments/browser-quickstart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Plural CD In-Browser Quickstart
title: Plural In-Browser Quickstart
description: Deploying your services using the Plural Console UI.
---

Expand Down
2 changes: 1 addition & 1 deletion pages-archive/deployments/ci-gh-actions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Github Actions Example
description: Call Plural CD from a simple Github Actions workflow
description: Call Plural from a simple Github Actions workflow
---

## Overview
Expand Down
2 changes: 1 addition & 1 deletion pages-archive/deployments/ci-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Deploying your services using the Plural Console UI.

## Overview

Plural CD is meant to help you separate the concerns around software delivery and deployment from your CI provider, which is usually purpose built for running unit tests and compiling build artifacts. There are some major motivations for this separation, among them being:
Plural is meant to help you separate the concerns around software delivery and deployment from your CI provider, which is usually purpose built for running unit tests and compiling build artifacts. There are some major motivations for this separation, among them being:

- Deployment is frequently a much longer running process than a standard code change, encompassing staged releases across multiple environments with multiple rounds of integration testing.
- A seperated CD system can make it easy to manage drift in micro-service dependencies by allowing them to be tested in tandem and rolled back independently.
Expand Down
2 changes: 1 addition & 1 deletion pages-archive/deployments/ci.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Integrate with Your CI
description: How to integrate Plural CD with your CI Provider, like Github Actions, Jenkins, or CircleCI
description: How to integrate Plural with your CI Provider, like Github Actions, Jenkins, or CircleCI
---
2 changes: 1 addition & 1 deletion pages-archive/deployments/cluster-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Spawn New Clusters with Cluster API

Plural supports both a Bring-Your-Own-Kubernetes model of cluster creation, and the ability to do full provisioning and lifecycle management of Kubernetes with Cluster API. If you'd rather define your clusters yourself using tools like terraform or Pulumi, feel free to check out the docs [here](deployments/import-cluster).

There are two tiers of cluster within Plural CD:
There are two tiers of cluster within Plural:

- Management Cluster - where the Plural control plane resides and also where CAPI controllers will reside. You are free to use this to host other services if you like, but security/reliability best-practices would suggest you at least segregate it from production systems
- Workload Cluster - where main production/staging services are hosted
Expand Down
2 changes: 1 addition & 1 deletion pages-archive/deployments/cluster-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Drain and Remove your Clusters

Plural supports two deletion models:

- drain - this will first delete all services in Plural CD before finally proceeding to deregister the cluster if BYOK or destroy it via Cluster API if it was a cluster api cluster
- drain - this will first delete all services in Plural before finally proceeding to deregister the cluster if BYOK or destroy it via Cluster API if it was a cluster api cluster
- soft - this will leave all the services in-place and simply remove the reference to the cluster in our system. You'll want to manually uninstall the agent in that cluster as well. This is meant primarily for BYOK clusters.

Before deleting your cluster, you should decide on which you'd prefer to do, if it's a full deletion, we'd recommend draining as it will ensure all load balancers/volumes are swept up upon cluster deletion
Expand Down
2 changes: 1 addition & 1 deletion pages-archive/deployments/import-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Set Up deployments to an existing, self-managed cluster

Most users will have created a significant amount of kubernetes infrastructure with tooling like terraform, pulumi or other forms of infrastructure automation. It's also very common for users to prefer sticking with their tried-and-true IaC patterns rather than futzing with cluster api, which we completely appreciate and wish to support fully.

You can easily configure deployments to these clusters by installing our agent with a single command, and Plural CD will manage that agent from then on without any manual intervention.
You can easily configure deployments to these clusters by installing our agent with a single command, and Plural will manage that agent from then on without any manual intervention.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion pages-archive/deployments/network-addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you'd like to learn more about more advanced uses of it, here are the [docs](

We provide a sane base-install of Cert Manager, using the http01 solver for letsencrypt. All it will ask for is an email for cert issuance notifications that letsencrypt sends as part of their protocol (they can be ignored for the most part).

If you want to set up your own issuers, I'd recommend reading the [docs](https://cert-manager.io/docs/configuration/acme/dns01/) and you are free to either fork our setup or create a new service in Plural CD defining your own issuer custom resources.
If you want to set up your own issuers, I'd recommend reading the [docs](https://cert-manager.io/docs/configuration/acme/dns01/) and you are free to either fork our setup or create a new service in Plural defining your own issuer custom resources.

## ExternalDNS

Expand Down
10 changes: 5 additions & 5 deletions pages/01-overview/02-architecture.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Plural CD Architecture
title: Architecture
description: Secure, Scalable Pull-Based Architecture
---

## Overview

Plural CD is based on a scalable, secure, agent-based pull architecture. It doesn't require direct access to any of the clusters it deploys to, meaning it can manage workloads in any cloud, on-prem, on the edge, or even on a local laptop running KIND. Further since it doesn't require networking intensive kubernetes watch streams, central access to kubernetes, or rely on single-mastered operator control loops, it should scale to virtually any size kubernetes fleet. We also enhance your kubernetes setup with an auth proxy, allowing you to have full visibility to your workloads without compromising the network security of your setup or require the creation of complex multi-cloud networking setups.
Plural is based on a scalable, secure, agent-based pull architecture. It doesn't require direct access to any of the clusters it deploys to, meaning it can manage workloads in any cloud, on-prem, on the edge, or even on a local laptop running KIND. Further since it doesn't require networking intensive kubernetes watch streams, central access to kubernetes, or rely on single-mastered operator control loops, it should scale to virtually any size kubernetes fleet. We also enhance your kubernetes setup with an auth proxy, allowing you to have full visibility to your workloads without compromising the network security of your setup or require the creation of complex multi-cloud networking setups.

Here's a quick diagram of the setup:

Expand All @@ -17,14 +17,14 @@ The Control Plane layer is a full-stack service deployable onto any kubernetes c

- Horizontally scalable git cache - we should be able to ingest as many git repos as you'd like and auto-shard them throughout your cluster automatically and efficiently.
- Configuration Management - supports re-configurable backends, but allows you to easily parameterize services with information like hostnames, docker image tags, and other secret and non-secret information.
- Auth Proxy - this is a secure bidirectional grpc channel initiated by a deployment agent used to make kubernetes api calls no matter where a cluster may live and give you full dashboarding capabilities from the Plural CD UI.
- Cluster API Providers - Plural CD natively integrates with cluster api and allows you to create and manage new clusters at scale and fork your own kubernetes cluster APIs on top of existing setups for services like EKS, AKS and GKE or on-prem solutions like Rancher
- Auth Proxy - this is a secure bidirectional grpc channel initiated by a deployment agent used to make kubernetes api calls no matter where a cluster may live and give you full dashboarding capabilities from the Plural UI.
- Cluster API Providers - Plural natively integrates with cluster api and allows you to create and manage new clusters at scale and fork your own kubernetes cluster APIs on top of existing setups for services like EKS, AKS and GKE or on-prem solutions like Rancher

We provide simple installers if you'd like to deploy the control plane layer to a kubernetes cluster already in your fleet, or you can use our own kubernetes setup in the standard plural install flow.

## Deployment Agent

A thin deployment agent is installed onto each cluster and perpetually managed by Plural CD from then on. It will perpetually poll the control plane for new services to apply and if there are any changes to make, apply them into your cluster. It also can do a few other things like:
A thin deployment agent is installed onto each cluster and perpetually managed by Plural from then on. It will perpetually poll the control plane for new services to apply and if there are any changes to make, apply them into your cluster. It also can do a few other things like:

- establish the bidectional grpc channel for the auth proxy layer (this does require an ingress with websocket support)
- execute integration tests
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# API Reference
---
title: API Reference
description: API reference for Plural
---



## Packages
- [deployments.plural.sh/v1alpha1](#deploymentspluralshv1alpha1)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Plural CD CLI Quickstart
title: Quickstart with the Plural CLI
description: Deploying your services using the Plural CLI.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Plural CD Bring-your-own-Kubernetes-cluster
description: Bootstrap Plural CD on an existing cluster
title: Bring your own K8s cluster
description: Bootstrap Plural on an existing cluster
---

## Overview

For users that just want to use our CD capabilities and full control of their kubernetes setup, you can install a simplified version of Plural CD onto an existing kubernetes cluster. We've made this a turnkey process, but there are some prerequisites, namely:
For users that just want to use our CD capabilities and full control of their kubernetes setup, you can install a simplified version of Plural onto an existing kubernetes cluster. We've made this a turnkey process, but there are some prerequisites, namely:

- You'll need to create a postgres db for state storage, and have a jdbc connection string for it ready of the form: `postgres://<user>:<password>@<host>:5432/<db>`
- You'll need to have your network setup in place so that all clusters you want to deploy to can make outbound network connections to the ingress you configure for plural CD, in general this means setting up:
Expand Down
6 changes: 3 additions & 3 deletions pages/02-getting-started/01-first-steps/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting Started with Plural CD
description: Guides you can use to get up and running quickly with Plural CD.
title: First steps
description: Guides you can use to get up and running quickly with Plural.
---
## Overview

Expand Down Expand Up @@ -35,4 +35,4 @@ We also have thorough documentation to explain how to get your cluster up and ru
We’ve also created a few example repos to show various use cases within Plural:

- `plural up` [demo](https://github.com/pluralsh/plural-up-demo) - this is a full repo generated by plural up which you can use as a guide if you chose the raw helm install path and still would like to have a more scaffolded experience.
- [Plural CD Demo](https://github.com/pluralsh/plrl-cd-demo) - this is a trivial python FastApi service with attendent kubernetes manifests and a github action that can show a simple pattern of how to integrate Plural with an existing microservice CI process.
- [Plural Demo](https://github.com/pluralsh/plrl-cd-demo) - this is a trivial python FastApi service with attendent kubernetes manifests and a github action that can show a simple pattern of how to integrate Plural with an existing microservice CI process.
2 changes: 1 addition & 1 deletion pages/02-getting-started/02-how-to-use/01-mgmt-cluster.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting Up a New Management (MGMT) Cluster
title: Provision a management cluster
description: Using Plural CLI to deploy a management (MGMT) Kubernetes cluster
---

Expand Down
2 changes: 1 addition & 1 deletion pages/02-getting-started/02-how-to-use/02-rbac.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting Up a RBAC in Your Kubernetes Dashboard
title: Add RBAC to the K8s dashboard
description: Use a simple global service to configure organization wide Kubernetes RBAC for end users
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Integrate with your Source Control Provider
title: Connect a source control provider
description: Setting up an SCM Connection in Plural to integrate with Github, GitLab, or BitBucket
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting Up Your First Workload Cluster
title: Provision a workload cluster
description: Using a self-service PR automation to provision your first workload cluster
---

Expand Down
2 changes: 1 addition & 1 deletion pages/02-getting-started/02-how-to-use/05-controllers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting Up Ingress on a Cluster
title: Set up ingress on a cluster
description: Setting up your edge networking on a cluster, and learn a bit about GlobalServices and Add-Ons
---

Expand Down
2 changes: 1 addition & 1 deletion pages/02-getting-started/02-how-to-use/06-pr-automation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Use PR Automations for General Self-Service
title: Use PR automations for self-service
description: Use a PR Automation for an example Self-Service S3 bucket creation workflow
---

Expand Down
2 changes: 1 addition & 1 deletion pages/02-getting-started/02-how-to-use/07-microservice.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting Up an Example Microservice
title: Deploy the first microservice
description: Deploying a basic microservice to a cluster managed by Plural
---

Expand Down
2 changes: 1 addition & 1 deletion pages/02-getting-started/02-how-to-use/08-pipelines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting Up a Dev->Prod Pipeline
title: Setup a dev -> prod pipeline
description: Using Plural PR-based Pipelines to automate Dev -> Staging -> Prod Promotions
---

Expand Down
2 changes: 1 addition & 1 deletion pages/02-getting-started/02-how-to-use/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: How To
title: How to use Plural
description: How To Guides for Getting the Most Out of Plural
---
These tutorials will guide you through a miniaturized example of the Kubernetes adoption process. The basic steps are:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sandboxing Your Cluster
title: Sandboxing your cluster
description: Deploy an instance with no outbound network dependencies to Plural
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Network Configuration
title: Network configuration
description: Modifying ingress controller and setting up public/private endpoints for your console
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Handling Private CAs
title: Handling private CAs
description: Configure certificate bundles in environments requiring a private CA
---

Expand Down
4 changes: 2 additions & 2 deletions pages/02-getting-started/03-advanced-config/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Advanced Config
description: Documentation and guides for working with Advanced Config.
title: Advanced configuration
description: Documentation and guides for working with Advanced Configuration.
---
## Overview

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Plural Deployment Operator
title: The deployment operator
description: GitOps Management using the Plural Operator
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Git Sourced Services
title: Git-sourced services
description: Source manifests directly from git
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Helm Sourced Services
title: Helm-sourced services
description: Source manifests from a helm repository registered anywhere
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Global Services
description: Replicate Services to all or part of your fleet
title: Global services
description: Replicate services to all or part of your fleet
---

Plural natively supports a concept of global services, e.g. a service that's replicated across a subset of your fleet. This is particular for low level kubernetes system add-ons like ingress controllers, service meshes, cert manager, etc. To define a global service, you first need to define a service that will serve as a source, then use the `GlobalService` CRD:
Expand Down
2 changes: 1 addition & 1 deletion pages/03-plural-features/01-continuous-deployment/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cluster Management
title: Continuous deployment
description: 'Manage a Kubernetes Fleet at Scale with Cluster API, or at your own pace'
---
## Overview
Expand Down
4 changes: 2 additions & 2 deletions pages/03-plural-features/02-k8s-upgrade-assistant/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Managing Deprecations and K8s upgrades
description: Navigating Kubernetes API deprecations with Plural
title: Plural upgrade assistant
description: Navigating Kubernetes API deprecations and upgrades with Plural
---
The Kubernetes API is constantly evolving, and APIs are periodically changed and deprecated. Before upgrading the Kubernetes version running on a cluster, you must make sure any API changes are addressed.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Customize Stack Runners
title: Customize stack runners
description: Configure runner pods to enable workload identity or EKS IRSA
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Stack PR Workflow
title: Stack PR workflow
description: API-Driven Infrastructure As Code CD
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Manual Runs
title: Manual runs
description: Repair errors or one-off tasks in the stack environment
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Local Execution
title: Local execution
description: Executing IaC from Plural Stacks Locally
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Custom Stacks
title: Custom stacks
description: Define your own command workflows to be executed via Stacks
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Auto Cancellation
title: Auto cancellation
description: Automatically cancel complex Terraform applies when alarms fire
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Terraform Interop with Service Contexts
title: Terraform interop with service contexts
description: Communicate data between terraform and kubernetes using Service Contexts
---

Expand Down Expand Up @@ -47,7 +47,7 @@ local {
}
```

## Attaching to a Plural CD ServiceDeployment
## Attaching to a Plural ServiceDeployment

You can also attach it to an externaldns service like so:

Expand Down
2 changes: 1 addition & 1 deletion pages/03-plural-features/03-stacks-iac-management/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Stacks
title: Stacks — IaC management
description: How to manage Infrastructure as Code at Scale Using Plural
---
The goal of Plural Stacks is to provide a scalable framework to manage infrastructure as code like Terraform, Ansible and Pulumi with a kubernetes-friendly, api-driven approach. The core workflow is as follows:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Creating Your Own Catalog
title: Creating your own catalog
description: Defining your own service catalogs with Plural
---

Expand Down
25 changes: 0 additions & 25 deletions pages/03-plural-features/04-service-catalog/01-overview.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Contribution Program
title: Contribution program
description: Contributing to Plural's Service Catalog
---

Expand Down
Loading

0 comments on commit 3582514

Please sign in to comment.