Skip to content

Commit 9b1ed03

Browse files
authored
Add Plural deployment instructions (#9455)
* Add initial Plural installation instructions. * Add to SUMMARY.md
1 parent e1968f6 commit 9b1ed03

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* [On Azure(VM)](deploying-airbyte/on-azure-vm-cloud-shell.md)
1515
* [On GCP (Compute Engine)](deploying-airbyte/on-gcp-compute-engine.md)
1616
* [On Kubernetes (Beta)](deploying-airbyte/on-kubernetes.md)
17+
* [On Plural (Beta)](deploying-airbyte/on-plural.md)
1718
* [On Oracle Cloud Infrastructure VM](deploying-airbyte/on-oci-vm.md)
1819
* [On Digital Ocean Droplet](deploying-airbyte/on-digitalocean-droplet.md)
1920
* [Operator Guides](operator-guides/README.md)

docs/deploying-airbyte/on-kubernetes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
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.
66

7+
## Quickstart
8+
9+
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.
10+
711
## Getting Started
812

913
### Cluster Setup

docs/deploying-airbyte/on-plural.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# On Plural (Beta)
2+
3+
## Overview
4+
5+
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.
6+
7+
## Getting Started
8+
9+
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
10+
application will be deployed to.
11+
12+
Then create a fresh Git repo to store your Plural installation and from within the repo, run:
13+
14+
```bash
15+
plural init
16+
```
17+
18+
This configures your installation and cloud provider for the repo. You're now ready to install Airbyte on your Plural repo!
19+
20+
## Installing Airbyte
21+
22+
To install Airbyte on your Plural repo, simply run:
23+
24+
```bash
25+
plural bundle install airbyte airbyte-aws
26+
```
27+
28+
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.
29+
30+
After this, run:
31+
32+
```bash
33+
plural build
34+
plural deploy --commit "Initial Deploy."
35+
```
36+
37+
## Accessing your Airbyte Installation
38+
39+
Now, just head over to airbyte.SUBDOMAIN_NAME.onplural.sh to access the Airbyte UI.
40+
41+
## Monitoring your Installation
42+
43+
To monitor and manage your Airbyte installation, head over to the Plural control panel at console.YOUR_ORGANIZATION.onplural.sh.

0 commit comments

Comments
 (0)