Skip to content

Commit b03f0fc

Browse files
authored
Feat/launchpad orientation map (#95)
1 parent 68ce78b commit b03f0fc

19 files changed

+48
-35
lines changed

docs/launchpad/advanced/advanced-kubernetes.md renamed to docs/launchpad/advanced-tutorials/advanced-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide provides a general walkthrough for installing Kubernetes using Fedora
66

77
## Prerequisites
88

9-
Before proceeding with this guide, ensure you have a solid understanding of how FCOS works and the steps required to install and enable FCOS as detailed in [Install FCOS Guide](../guides/install-fcos).
9+
Before proceeding with this guide, ensure you have a solid understanding of how FCOS works and the steps required to install and enable FCOS as detailed in [Install FCOS Guide](install-fcos.md).
1010

1111
Additionally, a clear grasp of the fundamental [Kubernetes architecture](https://devopscube.com/kubernetes-architecture-explained/) will greatly aid in navigating the guidance outlined ahead.
1212

docs/launchpad/guides/install-fcos.md renamed to docs/launchpad/advanced-tutorials/install-fcos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,4 +148,4 @@ If you've run the above command the folowing will happen on the host
148148

149149
## Next steps
150150

151-
The outlined steps mark the initial phase of grasping the workings of FCOS. For the different components that you'd need to include in your `butane` config to install Kuberneter follow [Advanced Kubernetes](../advanced/advanced-kubernetes).
151+
The outlined steps mark the initial phase of grasping the workings of FCOS. For the different components that you'd need to include in your `butane` config to install Kuberneter follow [Advanced Kubernetes](advanced-kubernetes.md).
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/launchpad/docs-map.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Launchpad Documentation
6+
7+
Everything you need to know about the Launchpad project.
8+
9+
## First steps
10+
11+
Are you new to Launchpad or to Kubernetes? Here's a high-level overview of how this documentation is organised, to help you know where to look for the information you need:
12+
13+
* **From Scratch** - this includes overview of the project, details on the project modularity and how you can leverage features of Launchpad as best suits your needs: [Launchpad Introduction](intro) | [Opt in features](modularity) | [Installation](client-side-tooling)
14+
* **Project Maintenance** - find out how often new versions of the project are released and how GraphOps decides what namespaces and chains to support: [Release Channels](release-channels) | [Supported Namespaces](supported-namespaces)
15+
* **Tutorials** - guides to get you started with Launchpad, everything you need to deploy different blockchain nodes and guides on what you need for highly available postgresql and monitoring: [Getting Started](quick-start) | [Arbitrum-One Guide](tutorials/arbitrum-archive-kubernetes-guide) | [Celo-Mainnet Guide](tutorials/celo-archive-kubernetes-guide) | [PostgreSQL HA](tutorials/postgresql_ha.md) | [Monitoring Stack HA](tutorials/monitoring-stack-with-HA.md)
16+
* **Advanced Tutorials** - want to start with Launchpad but you don't yet have a Kubernetes Cluster? Find out how to create one: [Creating a Kubernetes Cluster with kubeadm](advanced-tutorials/kubernetes-create-cluster-with-kubeadm) | [Creating a Kubernetes Cluster with FCOS](advanced-tutorials/advanced-kubernetes.md)
17+
18+
## Getting help
19+
20+
Having trouble? We'd like to help!
21+
22+
* The [FAQ](faq) page has answers to many common questions.
23+
* Not found something you need? See [FAQ: Need more help](faq#need-more-help) for information on getting support and asking questions.
24+
* Request new features, check out existing bugs or report new ones in [Launchpad Charts](https://github.com/graphops/launchpad-charts/issues) and [Launchpad Namespaces](https://github.com/graphops/launchpad-namespaces/issues)
25+
26+
27+
## Getting Involved
28+
29+
Launchpad is a collaborative effort to create the best UX for Graph Protocol Indexers on Kubernetes. As such contributors are highly appreciated and welcome. Visit the github repos' guidance to contribute code to [Launchpad Charts](https://github.com/graphops/launchpad-charts/blob/main/CONTRIBUTING.md) or [Launchpad Namespaces](https://github.com/graphops/launchpad-namespaces/blob/main/CONTRIBUTING.md)
30+
31+
You can also get involved by simply attending our biweekly [Launchpad Office Hours(LOH)](https://discord.com/events/438038660412342282/1229824398127534130) community call on discord. You can access previous LOH recordings [here](https://www.youtube.com/watch?v=qC5KbhD3urc&list=PLpbkfkwg_V6Ceidcn06VSP9BoU0g14voq).

docs/launchpad/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Normal WaitForFirstConsumer 6m52s persistentvolume-controlle
8989
9090
**Q: Do I need a specific CNI (Cilium, Calico etc) in order to use Launchpad?**
9191
92-
**A:** The Launchpad stack will work regardless of CNI used and in more general terms should work will all Kubernetes clusters - so you can customize your cluster how you prefer. In our [Kubernetes guide](guides/kubernetes-create-cluster-with-kubeadm.md) we use Cilium due to its use of [eBPF](https://ebpf.io/what-is-ebpf/) technology. This advanced approach offers a significant boost in efficiency, especially noticeable when managing a large number of nodes. It scales well and ensures lower latency, which is crucial for high-performance requirements. While Calico does enjoy a broader base of community support and is a strong choice with its iptables routing, Cilium has the upper advantage due to its performance and its more expansive set of features.
92+
**A:** The Launchpad stack will work regardless of CNI used and in more general terms should work will all Kubernetes clusters - so you can customize your cluster how you prefer. In our [Kubernetes guide](advanced-tutorials/kubernetes-create-cluster-with-kubeadm.md) we use Cilium due to its use of [eBPF](https://ebpf.io/what-is-ebpf/) technology. This advanced approach offers a significant boost in efficiency, especially noticeable when managing a large number of nodes. It scales well and ensures lower latency, which is crucial for high-performance requirements. While Calico does enjoy a broader base of community support and is a strong choice with its iptables routing, Cilium has the upper advantage due to its performance and its more expansive set of features.
9393
9494
It's important to acknowledge that while Cilium has better performance and features than Calico, it is a bit trickier to set up. Our decision isn't influenced by Launchpad; it's purely a preference based on the operational benefits that Cilium brings to our infrastructure.
9595

docs/launchpad/intro.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 2
33
---
44

55
# Introduction
@@ -22,9 +22,10 @@ There are three major components to be aware of:
2222
- Preconfigured namespaces for core cluster functions (logging, monitoring, etc) and major blockchains
2323
- An automated dependency update pipeline for [`graphops/launchpad-charts`](https://github.com/graphops/launchpad-charts) and [`graphops/launchpad-namespaces`](https://github.com/graphops/launchpad-namespaces)
2424

25+
Are you interested in exploring Launchpad but not ready to adopt the entire stack? Explore our [Modularity](modularity) page to discover how you can selectively integrate elements of Launchpad, like `launchpad-starter`, `launchpad-charts`, and `launchpad-namespaces`, to fit your specific needs without committing to a full end-to-end implementation.
26+
2527
## Next Steps
2628

27-
- Read the [Prerequisites](prerequisites) section to understand what you need to bring
29+
- Read the [Prerequisites](prerequisites) section to understand what you need to started
2830
- Read the [Quick Start guide](quick-start) to get up and running
29-
- Look at the repositories above on GitHub to understand how they work
30-
- Review **Advanced Topics** to understand more advanced behavior
31+
- Look at the repositories above on GitHub to understand how they work

docs/launchpad/prerequisites.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ Currently, Launchpad comes with support for Linux and MacOS clients. Windows is
4141

4242
The Launchpad project requires a certain level of familiarity with [Kubernetes](https://kubernetes.io/) and its intricacies. The extent of this Kubernetes expertise depends on your choice of cluster. Opting for a managed cluster from a leading Cloud Provider requires less intensive Kubernetes knowledge, as operating such a cluster is more straightforward, necessitating only a fundamental grasp of different Kubernetes resource types.
4343

44-
However, it's essential to note that managed clusters can be very costly when running blockchains. In contrast, selecting a self-managed cluster demands a deeper understanding, encompassing all components necessary for cluster provisioning and management - for more details on this please checkout our [Kubernetes guide](guides/kubernetes-create-cluster-with-kubeadm.md). Regardless of your choice, you'll need to create a Kubernetes cluster. This can involve setting up a self-managed cluster, as outlined in our [Fedora CoreOS guide](guides/install-fcos.md), or opting for a managed cluster provided by a major Cloud Provider like AWS or GCP.
44+
However, it's essential to note that managed clusters can be very costly when running blockchains. In contrast, selecting a self-managed cluster demands a deeper understanding, encompassing all components necessary for cluster provisioning and management. Regardless of your choice, you'll need to create a Kubernetes cluster.
45+
46+
For a detailed exploration of setting up a Kubernetes cluster yourself, please refer to our [Kubernetes guide](advanced-tutorials/kubernetes-create-cluster-with-kubeadm.md). If you choose to set up a self-managed cluster, you might consider using Fedora CoreOS as one of the possible options, detailed in our [Fedora CoreOS guide](advanced-tutorials/install-fcos.md), among other methods.
4547

4648
## Operational knowledge of Helm
4749

0 commit comments

Comments
 (0)