README
¶
The DevEx & Application-layer for your Internal Developer Platform
🌟 What is Rig?
Rig.dev is a complete service-lifecycle platform for Kubernetes. The Platform empowers developers with a developer-friendly deployment engine that simplifies the process of rolling out, managing, debugging, and scaling applications.
The Rig platform is self-hosted, can be installed in any Kubernetes cluster and will immediately simplify maintaining services in the cluster.
📦 Features
The complete stack offers:
- rig - The CLI for interacting with the rig-platform and its resources
- rig-operator - Our open-core abstraction implementation running in Kubernetes
- rig-platform - Our developer-friendly rollout engine and dashboard
- Helm charts for installing rig-operator and rig-platform
- The platform protobuf interfaces (allows for easy API-client generation)
- Plugin framework for easy integrations of the Platform with any infrastructure
- Simple CLI commands for integrating with any CI/CD pipeline
⚙️ Plugins
The Rig platform comes with an open Plugin framework, for easy customization.
The default configuration will run with the basic plugins:
- Deployment Plugin -
rigdev.deployment - CronJob Plugin -
rigdev.cronjob - Service Account Plugin -
rigdev.service_account - Ingress Rources Plugin -
rigdev.ingress_routes(must be configured, see here)
More helper-plugins are available here and used in a few examples described here.
To write your own plugins, see our Custom Plugin guide.
🧑💻 Getting Started
Our Setup 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 Slack channel.
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
|
|
|
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/platform/v1
+kubebuilder:object:generate=true +groupName=rig.platform
|
+kubebuilder:object:generate=true +groupName=rig.platform |
|
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 |
|
controller/plugin
nolint
|
nolint |
|
plugins
|
|
|
builtin/annotations
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
builtin/datadog
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
builtin/google_cloud_sql_auth_proxy
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
builtin/init_container
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
builtin/object_template
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
builtin/placement
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
builtin/sidecar
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
capsulesteps/cron_jobs
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
capsulesteps/deployment
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
capsulesteps/ingress_routes
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
capsulesteps/service_account
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
capsulesteps/service_monitor
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
capsulesteps/vpa
+groupName=plugins.rig.dev -- Only used for config doc generation
|
+groupName=plugins.rig.dev -- Only used for config doc generation |
|
tools
module
|