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

docs: launchpad v2 #67

Merged
merged 6 commits into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion docs/launchpad/advanced/advanced-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ Key features of `kubeadm` include:

* **Configuration Validation:** kubeadm performs preflight checks to validate whether the host system is ready for cluster creation or joining.

**Note:** If you opt for a multi-node Kubernetes cluster, your Butane configurations will differ based on the specific role each node plays, whether it's a control plane or a worker node.
:::note
If you opt for a multi-node Kubernetes cluster, your Butane configurations will differ based on the specific role each node plays, whether it's a control plane or a worker node.
:::

### Butane config for Kubernetes control-planes

Expand Down
10 changes: 7 additions & 3 deletions docs/launchpad/client-side-tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ sidebar_position: 5

# Client Side Tooling

Launchpad comes with an opinionated set of tools on your local machine, layered over one another to provide a declarative workflow through all the layers of your infrastructure.
Launchpad comes with an opinionated set of tools on your local machine, layered over one another to provide a declarative workflow to manage your cluster software stack.

![Client Side Stack](/img/launchpad-client-side-stack.svg)

These tools do not run on your servers, but on your local machine. They form the command & control center that you use to send instructions to your cluster of servers.
These tools do not run on your servers, but on your local machine. They form the command & control center that you use to send instructions to your cluster.

## Installing on your local machine

Expand All @@ -34,8 +34,12 @@ Launchpad uses Helm to deploy packages (Helm Charts) into your cluster.

Launchpad uses Helmfile to declare and manage sets of related Helm releases.

### Kustomize

[Kustomize](https://github.com/kubernetes-sigs/kustomize) lets you customize raw, template-free YAML files for multiple purposes, leaving the original YAML untouched and usable as is. It is used by helmfile for some of its features.

### Kubectl

[Kubectl](https://github.com/kubernetes/kubectl) is the command-line interface for Kubernetes that allows you to deploy, scale, and manage applications on a Kubernetes cluster. It provides a simple, easy-to-use command-line interface for performing common Kubernetes tasks such as creating and managing pods, services, and deployments.

Launchpad uses Kubectl to interact with your Kubernetes cluster.
Launchpad uses Kubectl to interact with your Kubernetes cluster.
4 changes: 2 additions & 2 deletions docs/launchpad/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Introduction

Launchpad is a toolkit for running a Graph Protocol Indexer on Kubernetes. It aims to provide the fastest path to production multi-chain indexing, with sane security and performance defaults. It should work well whether you have a single host or twenty. It is comprised of an opinionated set of tools on your local machine, layered over one another to provide a declarative workflow through all the layers of your infrastructure.
Launchpad is a toolkit for running a Graph Protocol Indexer on Kubernetes. It aims to provide the fastest path to production multi-chain indexing, with sane security and performance defaults. It should work well whether you have a single node cluster or twenty. It is comprised of an opinionated set of tools on your local machine, layered over one another to provide a declarative workflow to manage your deployments stack.

There are three major components to be aware of:

Expand All @@ -27,4 +27,4 @@ There are three major components to be aware of:
- Read the [Prerequisites](prerequisites) section to understand what you need to bring
- Read the [Quick Start guide](quick-start) to get up and running
- Look at the repositories above on GitHub to understand how they work
- Review **Advanced Topics** to understand more advanced behaviour
- Review **Advanced Topics** to understand more advanced behavior
2 changes: 1 addition & 1 deletion docs/launchpad/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ You will need to provision a Kubernetes cluster. This can be a self-managed clus

Launchpad is a collaborative effort to create the best UX for Graph Protocol Indexers on Kubernetes. The Launchpad stack provides an opinionated set of defaults and recipes for success, but to be an advanced operator you will need to learn Kubernetes and many of the other tools in the stack. With Launchpad, you have guard rails to guide you in your journey towards mastering operating your Indexer on Kubernetes.

Please contribute back when you are able!
Please contribute back when you are able!
Loading
Loading