From 4bbe8684ab8bd407576cb11d2f3c9d2990e7f1e0 Mon Sep 17 00:00:00 2001 From: Hans Rauer Date: Mon, 12 Feb 2024 11:46:22 +0100 Subject: [PATCH 1/6] put the guide into main deployment page --- pages/getting-started/deployments.md | 36 ++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/pages/getting-started/deployments.md b/pages/getting-started/deployments.md index a2d175de..7871bbf3 100644 --- a/pages/getting-started/deployments.md +++ b/pages/getting-started/deployments.md @@ -3,3 +3,39 @@ title: Getting Started with Plural CD description: >- Guides you can use to get up and running quickly with Plural CD. --- + +## Overview + +This guide is meant to give you an overview of all the materials needed to get started with Plural’s Fleet Management solution. +This should be considered a living document; feel free to let us know about any gaps in our documentation and we’ll make it a top priority to plug them to ensure as smooth an experience as possible for future customers. + +The general process of setting up your instance is pretty straightforward, and we have documentation and supporting materials below to guide each step: + +- set up your management cluster which will host the plural console and supporting operators +- connect your kubernetes clusters you’d like to manage to that management cluster +- define services, pipelines, and global services to start shipping workloads into your cluster fleet + +## Intro Video + +We think the easiest way to understand the workflow is to take a look at our intro video; we have an upload of it here: +{% embed url="https://assets.plural.sh/plural-up.mp4" aspectRatio="16 / 9" /%} + + +(It is about 14 minutes long). +This will give you a brief tour of using the `plural up` command to set up your management cluster, which you can use directly or can use as a starting point to rework the exact setup needed for your enterprise given security constraints and other considerations for your environment. + +## Getting Started Docs +We also have thorough documentation to explain how to get your cluster up and running. We recommend using the following: + +- [CLI Quickstart](https://docs.plural.sh/deployments/cli-quickstart) - details of how to install the Plural Console either on an existing cluster using helm or also guides you through the `plural up` process. +- [Import An Existing Cluster](https://docs.plural.sh/deployments/import-cluster) - some of the main ways to import a cluster you’ve created into Plural’s fleet manager. The main method is to simply use our CLI or to use our terraform provider. +- [Terraform Docs](https://registry.terraform.io/providers/pluralsh/plural/latest/docs) - docs for our terraform provider. +- [Cluster Management](https://docs.plural.sh/deployments/using-operator) - the entire section devoted to documenting all the relevant CRDs within the Plural operator. This is installed alongside the Console in your management cluster and allows for a fully GitOps management experience of the products core components. + + +## Example Repos + +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. From d039d79b9ede4a692b7debf9bdf72c782f87db96 Mon Sep 17 00:00:00 2001 From: Hans Rauer Date: Mon, 12 Feb 2024 12:58:58 +0100 Subject: [PATCH 2/6] directly link video, mp4 files are detect as audio by react-embed --- pages/getting-started/deployments.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/pages/getting-started/deployments.md b/pages/getting-started/deployments.md index 7871bbf3..b2a7d98b 100644 --- a/pages/getting-started/deployments.md +++ b/pages/getting-started/deployments.md @@ -17,21 +17,19 @@ The general process of setting up your instance is pretty straightforward, and w ## Intro Video -We think the easiest way to understand the workflow is to take a look at our intro video; we have an upload of it here: -{% embed url="https://assets.plural.sh/plural-up.mp4" aspectRatio="16 / 9" /%} +We think the easiest way to understand the workflow is to take a look at our intro video; we have an upload of it [here](https://assets.plural.sh/plural-up.mp4) - -(It is about 14 minutes long). +(It is about 14 minutes long). This will give you a brief tour of using the `plural up` command to set up your management cluster, which you can use directly or can use as a starting point to rework the exact setup needed for your enterprise given security constraints and other considerations for your environment. ## Getting Started Docs + We also have thorough documentation to explain how to get your cluster up and running. We recommend using the following: -- [CLI Quickstart](https://docs.plural.sh/deployments/cli-quickstart) - details of how to install the Plural Console either on an existing cluster using helm or also guides you through the `plural up` process. -- [Import An Existing Cluster](https://docs.plural.sh/deployments/import-cluster) - some of the main ways to import a cluster you’ve created into Plural’s fleet manager. The main method is to simply use our CLI or to use our terraform provider. +- [CLI Quickstart](https://docs.plural.sh/deployments/cli-quickstart) - details of how to install the Plural Console either on an existing cluster using helm or also guides you through the `plural up` process. +- [Import An Existing Cluster](https://docs.plural.sh/deployments/import-cluster) - some of the main ways to import a cluster you’ve created into Plural’s fleet manager. The main method is to simply use our CLI or to use our terraform provider. - [Terraform Docs](https://registry.terraform.io/providers/pluralsh/plural/latest/docs) - docs for our terraform provider. -- [Cluster Management](https://docs.plural.sh/deployments/using-operator) - the entire section devoted to documenting all the relevant CRDs within the Plural operator. This is installed alongside the Console in your management cluster and allows for a fully GitOps management experience of the products core components. - +- [Cluster Management](https://docs.plural.sh/deployments/using-operator) - the entire section devoted to documenting all the relevant CRDs within the Plural operator. This is installed alongside the Console in your management cluster and allows for a fully GitOps management experience of the products core components. ## Example Repos From ea9640f8bd18d19b585018041b2325b5bb4cc974 Mon Sep 17 00:00:00 2001 From: Hans Rauer Date: Mon, 12 Feb 2024 13:48:23 +0100 Subject: [PATCH 3/6] connect sentences --- pages/getting-started/deployments.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/pages/getting-started/deployments.md b/pages/getting-started/deployments.md index b2a7d98b..1a24171e 100644 --- a/pages/getting-started/deployments.md +++ b/pages/getting-started/deployments.md @@ -17,9 +17,7 @@ The general process of setting up your instance is pretty straightforward, and w ## Intro Video -We think the easiest way to understand the workflow is to take a look at our intro video; we have an upload of it [here](https://assets.plural.sh/plural-up.mp4) - -(It is about 14 minutes long). +We think the easiest way to understand the workflow is to take a look at our intro video; we have an upload of it [here](https://assets.plural.sh/plural-up.mp4) (It is about 14 minutes long). This will give you a brief tour of using the `plural up` command to set up your management cluster, which you can use directly or can use as a starting point to rework the exact setup needed for your enterprise given security constraints and other considerations for your environment. ## Getting Started Docs From d04a27387e83b7c0aa5283e9d8e16df08052d1e0 Mon Sep 17 00:00:00 2001 From: Hans Rauer Date: Mon, 12 Feb 2024 14:27:54 +0100 Subject: [PATCH 4/6] fix plural cd demo link --- pages/getting-started/deployments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/getting-started/deployments.md b/pages/getting-started/deployments.md index 1a24171e..2fb45d36 100644 --- a/pages/getting-started/deployments.md +++ b/pages/getting-started/deployments.md @@ -34,4 +34,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 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. From 4315387d6511dd80f0a32f1808d015fa6c114b32 Mon Sep 17 00:00:00 2001 From: Hans Rauer Date: Mon, 12 Feb 2024 15:00:42 +0100 Subject: [PATCH 5/6] embed with yt --- pages/getting-started/deployments.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pages/getting-started/deployments.md b/pages/getting-started/deployments.md index 2fb45d36..cd80c820 100644 --- a/pages/getting-started/deployments.md +++ b/pages/getting-started/deployments.md @@ -17,7 +17,10 @@ The general process of setting up your instance is pretty straightforward, and w ## Intro Video -We think the easiest way to understand the workflow is to take a look at our intro video; we have an upload of it [here](https://assets.plural.sh/plural-up.mp4) (It is about 14 minutes long). +We think the easiest way to understand the workflow is to take a look at our intro video (It is about 14 minutes long): + +{% embed url="https://www.youtube.com/watch?v=caDlvskRkAw&ab_channel=Plural" aspectRatio="16 / 9" /%} + This will give you a brief tour of using the `plural up` command to set up your management cluster, which you can use directly or can use as a starting point to rework the exact setup needed for your enterprise given security constraints and other considerations for your environment. ## Getting Started Docs From 230de3d394fe2f3c8417cfe334470fa5d1a3454d Mon Sep 17 00:00:00 2001 From: Hans Rauer Date: Mon, 12 Feb 2024 15:14:24 +0100 Subject: [PATCH 6/6] link looks funky with backticks --- pages/getting-started/deployments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/getting-started/deployments.md b/pages/getting-started/deployments.md index cd80c820..a8ea2daa 100644 --- a/pages/getting-started/deployments.md +++ b/pages/getting-started/deployments.md @@ -36,5 +36,5 @@ 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 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.