supabase-operator/docs/getting_started.md

# Getting Started

## Dependencies

The operator has the following dependencies:

- [cert-manager](https://cert-manager.io/) (to issue webhook certificates)

## Deploying the operator

The easiest way to deploy the operator is to fetch the manifest from the [releases](https://code.icb4dc0.de/prskr/supabase-operator/releases) and apply it like this:

```bash
kubectl apply --server-side -f manifest.yaml
```

The manifest is rendered as part of the release workflow and based on [kustomize](https://kustomize.io/).
If you want to customize the deployment, you can start from the [release/default](https://code.icb4dc0.de/prskr/supabase-operator/src/branch/main/config/release/default) layer and build your own manifest.

## Deploying a basic Supabase instance

As described in the [overview](./components/overview.md) the custom resources are 'grouping' the Supabase services into 'modules'.
A common basic instance requires:

- a [`Core`](./components/core.md) instance (PostgREST, Auth & DB migrations)
- an [`APIGateway`](./components/apigateway.md) instance (gateway to handle JWT auth and routing)

it is perfectly possible to deploy for instance only an `APIGateway` and a `Storage` instance as well if you don't need the API or you can also manage your own API gateway if you prefer it that way.
The operator setup tries to be as 'unopinionated' as possible.
docs: initial CI setup 2025-01-21 10:31:02 +01:00			`# Getting Started`

docs: extend docs 2025-01-28 18:01:34 +01:00			`## Dependencies`

			`The operator has the following dependencies:`

			`- [cert-manager](https://cert-manager.io/) (to issue webhook certificates)`

docs: initial CI setup 2025-01-21 10:31:02 +01:00			`## Deploying the operator`

			`The easiest way to deploy the operator is to fetch the manifest from the [releases](https://code.icb4dc0.de/prskr/supabase-operator/releases) and apply it like this:`

			```bash
			`kubectl apply --server-side -f manifest.yaml`
			```

			`The manifest is rendered as part of the release workflow and based on [kustomize](https://kustomize.io/).`
			`If you want to customize the deployment, you can start from the [release/default](https://code.icb4dc0.de/prskr/supabase-operator/src/branch/main/config/release/default) layer and build your own manifest.`

			`## Deploying a basic Supabase instance`
docs: extend docs 2025-01-28 18:01:34 +01:00
			`As described in the [overview](./components/overview.md) the custom resources are 'grouping' the Supabase services into 'modules'.`
			`A common basic instance requires:`

			- a [`Core`](./components/core.md) instance (PostgREST, Auth & DB migrations)
			- an [`APIGateway`](./components/apigateway.md) instance (gateway to handle JWT auth and routing)

			it is perfectly possible to deploy for instance only an `APIGateway` and a `Storage` instance as well if you don't need the API or you can also manage your own API gateway if you prefer it that way.
			`The operator setup tries to be as 'unopinionated' as possible.`