README
¶
The application platform for Kubernetes
🌟 What is Rig?
Rig.dev offers an application platform for Kubernetes. We empower developers with our developer-friendly deployment engine that simplifies the process of rolling out, managing, debugging, and scaling applications.
📦 Features
Our core is open-source and features:
- rig-operator - Our abstraction on top of Kubernetes
- rig - The CLI for interacting with the rig-platform and its resources
- Helm charts for installing rig-operator and rig-platform
- The platform protobuf interfaces (allows for easy API-client generation)
🧑💻 Getting Started
Our Getting Started Guide is available here.
The guide allows you to set up either your local machine or a Kubernetes cluster in production.
👯 Community
For support, development, and community questions, we recommend checking out our Discord server.
Furthermore, be sure to check out our Code of Conduct.
➕ Contributions
We love additions in all forms, to make Rig even greater.
The easiest steps are to file bug reports, gaps in documentation, etc. If you know how to improve it yourself, we encourage you to fork the relevant repository and create a Pull Request.
📖 License
Rig is licensed under the Apache 2.0 License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
rig
command
|
|
|
rig-operator
command
|
|
|
rig-ops
command
|
|
|
gen
|
|
|
pkg
|
|
|
api/config/v1alpha1
Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group +kubebuilder:object:generate=true +groupName=config.rig.dev
|
Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group +kubebuilder:object:generate=true +groupName=config.rig.dev |
|
api/v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=rig.dev
|
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=rig.dev |
|
api/v1alpha2
Package v1alpha2 contains API Schema definitions for the v1alpha2 API group +kubebuilder:object:generate=true +groupName=rig.dev
|
Package v1alpha2 contains API Schema definitions for the v1alpha2 API group +kubebuilder:object:generate=true +groupName=rig.dev |
|
plugins
|
|
|
annotations
command
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
datadog
command
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
env_mapping
command
|
|
|
google_cloud_sql_auth_proxy
command
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
init_container
command
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
object_template
command
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
placement
command
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
sidecar
command
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
tools
module
|