Skip to content

Commit

Permalink
Add Plural deployment instructions (#9455)
Browse files Browse the repository at this point in the history
* Add initial Plural installation instructions.

* Add to SUMMARY.md
  • Loading branch information
avaidyanatha authored Jan 12, 2022
1 parent e1968f6 commit 9b1ed03
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* [On Azure(VM)](deploying-airbyte/on-azure-vm-cloud-shell.md)
* [On GCP (Compute Engine)](deploying-airbyte/on-gcp-compute-engine.md)
* [On Kubernetes (Beta)](deploying-airbyte/on-kubernetes.md)
* [On Plural (Beta)](deploying-airbyte/on-plural.md)
* [On Oracle Cloud Infrastructure VM](deploying-airbyte/on-oci-vm.md)
* [On Digital Ocean Droplet](deploying-airbyte/on-digitalocean-droplet.md)
* [Operator Guides](operator-guides/README.md)
Expand Down
4 changes: 4 additions & 0 deletions docs/deploying-airbyte/on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

Airbyte allows scaling sync workloads horizontally using Kubernetes. The core components \(api server, scheduler, etc\) run as deployments while the scheduler launches connector-related pods on different nodes.

## Quickstart

If you don't want to configure your own K8s cluster and Airbyte instance, you can use the free, open-source project [Plural](https://www.plural.sh/) to bring up a K8s cluster and Airbyte for you. Use [this guide](on-plural.md) to get started.

## Getting Started

### Cluster Setup
Expand Down
43 changes: 43 additions & 0 deletions docs/deploying-airbyte/on-plural.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# On Plural (Beta)

## Overview

Plural is a unified application deployment platform that makes it easy to run open-source software on Kubernetes. It aims to make applications as portable as possible, without sacrificing the ability for the users to own the applications they desire to use.

## Getting Started

First, install Plural and the Plural CLI by following steps 1, 2, and 3 of the instructions [here](https://docs.plural.sh/getting-started). Through this, you will also configure your cloud provider and the domain name under which your
application will be deployed to.

Then create a fresh Git repo to store your Plural installation and from within the repo, run:

```bash
plural init
```

This configures your installation and cloud provider for the repo. You're now ready to install Airbyte on your Plural repo!

## Installing Airbyte

To install Airbyte on your Plural repo, simply run:

```bash
plural bundle install airbyte airbyte-aws
```

The CLI will prompt you to choose whether or not you want to use Plural OIDC, which means you're using Plural as your identity provider for SSO.

After this, run:

```bash
plural build
plural deploy --commit "Initial Deploy."
```

## Accessing your Airbyte Installation

Now, just head over to airbyte.SUBDOMAIN_NAME.onplural.sh to access the Airbyte UI.

## Monitoring your Installation

To monitor and manage your Airbyte installation, head over to the Plural control panel at console.YOUR_ORGANIZATION.onplural.sh.

0 comments on commit 9b1ed03

Please sign in to comment.