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

put the guide into main deployment page #249

Merged
merged 6 commits into from
Feb 12, 2024
Merged
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
35 changes: 35 additions & 0 deletions pages/getting-started/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,38 @@ 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 (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

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.
Loading