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.

Sign up for GitHub

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

Polish docs for installing airbyte on Plural #9461

Merged
merged 2 commits into from
Jan 13, 2022
Merged

Polish docs for installing airbyte on Plural #9461

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81c9d30
Polish docs for installing airbyte on Plural
michaeljguarino Jan 13, 2022
f5a1dc7
addressed Abhi's comments
michaeljguarino Jan 13, 2022
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
33 changes: 28 additions & 5 deletions docs/deploying-airbyte/on-plural.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ Plural is a unified application deployment platform that makes it easy to run op

## 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.
First, create an account on https://app.plural.sh. This is simply to track your installations and allow for the delivery of automated upgrades, you will not be asked to provide any infrastructure credentials or sensitive information.

Then, install 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:

Expand All @@ -25,19 +26,41 @@ To install Airbyte on your Plural repo, simply run:
plural bundle install airbyte airbyte-aws
```

Plural's Airbyte distribution currently has support for AWS, GCP and Azure set up and ready to go, so feel free to pick whichever best fits your infrastructure.

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."
plural deploy --commit "deploying airbyte"
```

## Adding the Plural Console

To make management of your installation as simple as possible, we recommend installing the Plural Console. The console provides tools to manage resource scaling, receiving automated upgrades and getting out-of-the-box dashboarding and log aggregation. This can be done using the exact same process as above:

```bash
plural bundle install console console-aws
plural build
plural deploy --commit "deploying the console too"
```

## Accessing your Airbyte Installation

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

## Monitoring your Installation
## Accessing your Console Installation

To monitor and manage your Airbyte installation, head over to the Plural Console at console.YOUR_ORGANIZATION.onplural.sh (or whichever subdomain you chose).

## Troubleshooting

If you have any issues with installing Airbyte on Plural, feel free to jump into our [discord](https://discord.gg/bEBAMXV64s) and we can help you out.

If you'd like to request any new features for our Airbyte install, feel free to open an issue or PR at https://github.com/pluralsh/plural-artifacts.

## Further Reading

To monitor and manage your Airbyte installation, head over to the Plural control panel at console.YOUR_ORGANIZATION.onplural.sh.
To learn more about what you can do with Plural and more advanced uses of the platform, feel free to dive deeper into our docs [here](https://docs.plural.sh)