README
¶
Make shipping applications more enjoyable.
KubeVela
KubeVela is a modern application engine that adapts to your application's needs, not the other way around.
Community
- Slack: CNCF Slack #kubevela channel
- Gitter: Discussion
- Bi-weekly Community Call: Meeting Notes
Introduction
Developers simply want to deploy.
Traditional Platform-as-a-Service (PaaS) systems enable easy application deployments, but this happiness disappears when your application outgrows the capabilities of your platform. This is inevitable regardless of your PaaS is built on Kubernetes or not - the root cause is its inflexibility.
KubeVela is a modern application deployment system that adapts to your needs. Essentially, KubeVela enables you to define platform capabilities (such as workloads, operational behaviors, and cloud services) as reusable CUE or Helm components, per needs of your application deployment. And when your needs grow, your platform capabilities expand naturally in a programmable approach.
Perfect in flexibility though, X-as-Code tends to lead to configuration drift. That's why KubeVela is fully built as a Kubernetes Controller instead of a client-side tool, i.e. all its capabilities are modeled as code but enforced with battle tested reconciling loops which will never leave inconsistency in your clusters. Think about Platform-as-Code enabled by Kubernetes, CUE and Helm.
With developer experience in mind, KubeVela exposes those programmable platform capabilities as application-centric API shown as below:
- Components - deployable/provisionable entities that composed your application deployment
- e.g. a Kubernetes workload, a MySQL database, or a AWS OSS bucket
- Traits - attachable operational features per your needs
- e.g. autoscaling rules, rollout strategies, ingress rules, sidecars, security policies etc
- Application - full description of your application deployment assembled with components and traits.
Getting Started
Features
- Zero-restriction application deployment system - design and express platform capabilities with CUE and Helm per needs of your application, and let Kubernetes controller guarantee the determinism in the application deployment. GUI forms are automatically generated for capabilities so even your dashboard are fully extensible.
- Generic progressive rollout framework - built-in rollout framework and strategies to upgrade your microservice regardless of its workload type (e.g. stateless, stateful, or even custom operators etc).
- Multi-cluster multi-revision application deployment - built-in model to deploy or rollout your apps across hybrid infrastructures, with Service Mesh for traffic shifting.
- Simple and native - KubeVela is a just simple Kubernetes custom controller, all its capabilities are defined as Custom Resources so they naturally work with any CI/CD or GitOps tools which work with Kubernetes.
Documentation
Visit the KubeVela documentation site to find Installation Instruction, Platform Builder Guide and Developer Experience Guide.
Talks and Conferences
Contributing
Check out CONTRIBUTING to see how to develop with KubeVela.
Code of Conduct
KubeVela adopts CNCF Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apis contains all api types of KubeVela
|
Package apis contains all api types of KubeVela |
|
core.oam.dev
Package core_oam_dev contains API Schema definitions for the core.oam.dev v1alpha2 API group
|
Package core_oam_dev contains API Schema definitions for the core.oam.dev v1alpha2 API group |
|
core.oam.dev/common
Package common contains types required for both v1alpha2 and v1beta1 +kubebuilder:object:generate=true
|
Package common contains types required for both v1alpha2 and v1beta1 +kubebuilder:object:generate=true |
|
core.oam.dev/v1alpha2
Package v1alpha2 contains resources relating to the Open Application Model.
|
Package v1alpha2 contains resources relating to the Open Application Model. |
|
core.oam.dev/v1beta1
Package v1beta1 contains resources relating to the Open Application Model.
|
Package v1beta1 contains resources relating to the Open Application Model. |
|
standard.oam.dev/v1alpha1
Package v1alpha1 contains API Schema definitions for the standard v1alpha1 API group +kubebuilder:object:generate=true +groupName=standard.oam.dev
|
Package v1alpha1 contains API Schema definitions for the standard v1alpha1 API group +kubebuilder:object:generate=true +groupName=standard.oam.dev |
|
cmd
|
|
|
hack
|
|
|
legacy
|
|
|
pkg
|
|
|
appfile/helm/flux2apis
Package apis contains typed structs from fluxcd/helm-controller and fluxcd/source-controller.
|
Package apis contains typed structs from fluxcd/helm-controller and fluxcd/source-controller. |
|
controller/core.oam.dev/v1alpha2/core/components
Package components provides components related controllers.
|
Package components provides components related controllers. |
|
controller/core.oam.dev/v1alpha2/core/scopes
Package scopes provides scope related controllers.
|
Package scopes provides scope related controllers. |
|
controller/core.oam.dev/v1alpha2/core/traits
Package traits provides traits related controllers.
|
Package traits provides traits related controllers. |
|
controller/core.oam.dev/v1alpha2/core/workloads
Package workloads provides workloads related controllers.
|
Package workloads provides workloads related controllers. |
|
oam
Package oam contains miscellaneous OAM helper types.
|
Package oam contains miscellaneous OAM helper types. |
|
oam/mock
Package mock provides fake OAM resources for use in tests.
|
Package mock provides fake OAM resources for use in tests. |
|
references
|
|
|
test
|
|