Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DylanNWatt committed Oct 28, 2024
1 parent 7b0a609 commit cce02eb
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 15 deletions.
39 changes: 27 additions & 12 deletions doc_site/docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,45 @@
Relativistic Documentation
==========================

**Relativistic** is the fastest way to get a SOC2 compliant open source data stack up and running, saving tens or hundreds of thousands of dollars in vendor costs.
**Relativistic** is the fastest way to get a SOC2 compliant data stack based on open source tools up and running, saving hundreds of thousands of dollars in vendor costs.

Relativistic is a configuration tool for deploying open source data tools on a Kubernetes cluster via Terraform. It allows you to deploy over a dozen of the most popular data tools on Kubernetes in under 5 minutes. From dashboarding to ETLs to DAG schedulers to metrics and more, Relativistic has you covered.

Relativistic is a configuration tool for deploying open source data tools on your Kubernetes cluster via Terraform. It allows you to deploy over a dozen of the most popular data tools on Kubernetes in under 5 minutes. From dashboarding to ETLs to DAG schedulers to metrics and more, Relativistic has you covered.

Open source data tools often are better than their closed source counterparts. The issue is deploying them in a way that is secure, scalable, maintainable, and compliant. Relativistic comes from the learnings of a data consultancy deploying the same tools to dozens of clients, and how to get running in a day.
Many open source data tools are better than their closed source counterparts. The issue is deploying them in a way that is secure, scalable, maintainable, and compliant. Relativistic comes from the learnings of a data consultancy deploying the same tools to dozens of clients, and how to get running in a day.


Example - Set up Superset
----

**Step 1.** On a machine with `Docker Desktop Kubernetes <https://docs.docker.com/desktop/kubernetes>`_ and terraform installed:
**Code** On a machine with `Docker Desktop Kubernetes <https://docs.docker.com/desktop/kubernetes>`_ and terraform installed:

.. code-block:: hcl
provider "kubernetes" {
config_path = "~/.kube/config"
}
.. code-block:: console
provider "helm" {
kubernetes {
config_path = "~/.kube/config"
}
}
$ git clone https://github.com/kadreio/relativistic
$ cd relativistic/examples/local_superset
$ terraform init && terraform apply --auto-approve
$ open http://localhost:30086
module "relativistic" {
source = "kadreio/relativistic/kubernetes"
superset_enabled = true
superset_default_password = "starting_password_to_change"
superset_default_user = "[email protected]"
superset_secret_key = random_string.cookie_key.result
}
**Step 2.** You have a data stack on your local Kubernetes cluster!
resource "random_string" "cookie_key" {
length = 32
special = false
}
**Step 3.** Now set up a kubernetes cluster in AWS, Azure, GCP, or Digital Ocean, and deploy Relativistic to it instead.
**Step 2.** Run `terraform init && terraform apply --auto-approve`

**Step 3.** Open `http://localhost:30086` in your browser - or if using minikube, `minikube tunnel`, and use that IP.

Supported Tools
----
Expand Down
5 changes: 2 additions & 3 deletions doc_site/docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ While not strictly necessary, under the hood, many of the modules that relativis
Terraform
---------

Terraform is an "IAC" tool. It allows you to define the infrastructure you need in code, and then apply those definitions to create it. Relatistic's entrypoint is a terraform module, which bootstraps kuberenetes resources to your cluster. It is recommended that your familiar with terraform before deploying relativistic to production, to understand how to manage infrastructure over time.
Terraform is an "Infrastructure as Code" tool. It allows you to define the infrastructure you need in code, and then apply those definitions to create it. Relativistic's entrypoint is a terraform module, which bootstraps kubernetes resources to your cluster. It is recommended that your familiar with terraform before deploying relativistic to production, to understand how to manage infrastructure over time.

Both OpenTOFU and Terraform work:

Expand Down Expand Up @@ -85,8 +85,7 @@ Create this `main.tf` file in a new project directory, changing the password and
}
module "relativistic" {
source = "github.com/kadreio/relativistic.git?ref=v0.0.4-rc1"
source = "kadreio/relativistic/kubernetes"
superset_enabled = true
superset_default_password = "starting_password_to_change"
superset_default_user = "[email protected]"
Expand Down

0 comments on commit cce02eb

Please sign in to comment.