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

feat(launchpad): added examples on how to use charts with helmfile #96

Merged
merged 6 commits into from
May 8, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ kubeadm upgrade plan
```

**3:** Perform the upgrade:

*Note*: If you have local patches applied to your Kubernetes setup (ie. altering the kube-scheduler or kube-controller-manager configurations for better performance under specific workloads or hardware configurations), ensure they are included or updated appropriately during the upgrade process. To do this pass the `--patches /path/to/your/patches` flag to your `kubeadm upgrade apply` command.

```bash
kubeadm upgrade apply v1.28.3
```
Expand Down
4 changes: 3 additions & 1 deletion docs/launchpad/docs-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ sidebar_position: 1

# Launchpad Documentation

Everything you need to know about the Launchpad project.
Launchpad is a comprehensive toolkit designed for running a Graph Protocol Indexer on Kubernetes, aimed at providing the fastest route to production deployments of multi-chain indexing software stacks with robust security and performance defaults. Suitable for environments ranging from a single node cluster to large scale multi-region clusters. Launchpad is also comprised of an opinionated set of tools that run on your local machine, that are layered to offer a declarative workflow for managing your deployment stack. Key components of Launchpad include the Launchpad Starter ([`graphops/launchpad-starter`](https://github.com/graphops/launchpad-starter)), which serves as the initial setup point for new deployments; Launchpad Charts ([`graphops/launchpad-charts`](https://github.com/graphops/launchpad-charts)), a collection of Helm Charts for blockchains and web3 applications; and Launchpad Namespaces ([`graphops/launchpad-namespaces`](https://github.com/graphops/launchpad-namespaces)), which are preconfigured Kubernetes Namespaces that utilize Helmfile for enhanced management.

Here's a guide to help you navigate this documentation based on the information you're seeking:

## First steps

Expand Down
17 changes: 17 additions & 0 deletions docs/launchpad/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Here are answers to some commonly asked questions. If you have a question that i
- [Is there a way to inject a pretuned postgres config into the chart?](#is-there-a-way-to-inject-a-pretuned-postgres-config-into-the-chart)
- [Why are my stateful pods in `Pending` state and their expected `pvc` showing `WaitForFirstConsumer` errors?](#why-are-my-stateful-pods-in-pending-state-and-their-expected-pvc-showing-waitforfirstconsumer-errors)
- [Do I need to use Cilium for Launchpad?](#do-i-need-to-use-cilium-for-launchpad)
- [How active is the Launchpad project?](#how-active-is-the-launchpad-project)
- [I'm not ready to use Launchpad but I use Kubernetes](#im-not-ready-to-use-launchpad-but-i-use-kubernetes)
- [Need More Help?](#need-more-help)

---
Expand Down Expand Up @@ -93,6 +95,21 @@ Normal WaitForFirstConsumer 6m52s persistentvolume-controlle

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.

---

### How active is the Launchpad project?

**Q: How often is the Launchpad project updated?**

**A:** The GraphOps team actively maintains the Launchpad project as it is integral to their indexing infrastructure. For details on how new versions of applications (ie. Erigon, Graph-node etc) are integrated into Launchpad Charts and Launchpad Namespaces, please refer to our [Release Channels documentation](release-channels.md). Additionally, you can learn about our criteria for supporting different Launchpad Namespaces by visiting the [Supported Namespaces page](supported-namespaces.md). These resources provide a comprehensive view of our update frequency and decision-making processes regarding the inclusion of new features and applications.

---

### I'm not ready to use Launchpad but I use Kubernetes

**Q: Is this project relevant to me if I use Kubernetes to manage blockchain infrastructure?**

**A:** Absolutely, the Launchpad project is designed with modularity at its core, making it highly adaptable for users who aren't ready to fully implement all of its components. You can benefit from using our Launchpad Charts with Helm to manage specific components of your blockchain infrastructure independently. Additionally, our charts are compatible with GitOps workflows, allowing you to integrate them seamlessly into your existing management practices. For further insights into how you can leverage the modular aspects of our project, please visit our [Modularity documentation](modularity.md).

## Need More Help?

Expand Down
3 changes: 2 additions & 1 deletion docs/launchpad/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ There are three major components to be aware of:

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.

## Next Steps
## Next steps

- Visit our [Documentation Map](docs-map) for an overview of where to find all the information you need
- Read the [Prerequisites](prerequisites) section to understand what you need to started
- Read the [Quick Start guide](quick-start) to get up and running
- Look at the repositories above on GitHub to understand how they work
Loading
Loading