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

📝 Simplify quickstart guide #10

Merged
merged 1 commit into from
Aug 13, 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
44 changes: 6 additions & 38 deletions docs/tutorials/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,51 +17,19 @@ You will need to have the following tools installed in your system:

## Installation

### Create a Kubernetes Cluster
There are two main ways to run Dracon: Either you install the latest release, or you build it from the source.
For both options you'll just need to run a single command.

Dracon requires a Kubernetes cluster to run in. We will use [KinD](https://kind.sigs.k8s.io/) to create one. Just run:
### Option 1: Install Latest Release

```bash
./scripts/kind-with-registry.sh
make install
```

:::tip

Already have a local Kubernetes cluster? Skip ahead to the next step!

:::

### Deploy Dracon

Next, we need to deploy Dracon into our cluster. You can do this by running the following command:

```bash
make dev-deploy DRACON_VERSION=v0.19.0
```

This will deploy various things to your cluster: Dracon itself, but also supporting tools, such as Elastic Search. Running this command might take a couple of minutes. It's the perfect time to go get a cup of coffee! 😉

```text
) (
( ) )
) ( (
-------
.-\ /
'- \ /
_______
```

### Deploy Dracon Components

Next, we need to install some components. Components are the basic building blocks of Dracon. They can be easily installed as follows:
### Option 2: Build from Source

```bash
helm upgrade \
--install \
--namespace dracon \
--version 0.19.0 \
dracon-oss-components \
oci://ghcr.io/ocurity/dracon/charts/dracon-oss-components
make dev-deploy
```

And that's it! Dracon is now up and running on your cluster and you can start using it.
Expand Down