README
¶
Make shipping applications more enjoyable.
Introduction
KubeVela is a modern application delivery platform that makes deploying and operating applications across today's hybrid, multi-cloud environments easier, faster and more reliable.
Highlights
KubeVela practices the "render, orchestrate, deploy" workflow with below highlighted values added to existing ecosystem:
Deployment as Code
Declare your deployment plan as workflow, run it automatically with any CI/CD or GitOps system, extend or re-program the workflow steps with CUE. No ad-hoc scripts, no dirty glue code, just deploy. The deployment workflow in KubeVela is powered by Open Application Model.
Built-in observability, multi-tenancy and security support
Choose from the wide range of LDAP integrations we provided out-of-box, enjoy enhanced multi-tenancy and multi-cluster authorization and authentication, pick and apply fine-grained RBAC modules and customize them as per your own supply chain requirements. All delivery process has fully automated observability dashboards.
Multi-cloud/hybrid-environments app delivery as first-class citizen
Natively supports multi-cluster/hybrid-cloud scenarios such as progressive rollout across test/staging/production environments, automatic canary, blue-green and continuous verification, rich placement strategy across clusters and clouds, along with automated cloud environments provision.
Lightweight but highly extensible architecture
Minimize your control plane deployment with only one pod and 0.5c1g resources to handle thousands of application delivery. Glue and orchestrate all your infrastructure capabilities as reusable modules with a highly extensible architecture and share the large growing community addons.
Getting Started
Get Your Own Demo with Alibaba Cloud
-
install KubeVela on a Serverless K8S cluster in 3 minutes, try:
Documentation
Full documentation is available on the KubeVela website.
For building, running, and debugging vela-core locally, see
docs/development/.
Blog
Official blog is available on KubeVela blog.
Community
We want your contributions and suggestions! One of the easiest ways to contribute is to participate in discussions on the Github Issues/Discussion, chat on IM or the community calls. See COMMUNITY.md for Slack, DingTalk, WeChat, and meeting info, and the KubeVela community repo for joining links, the current meeting schedule, and developer and contributing guidelines.
Talks and Conferences
Check out KubeVela videos for these talks and conferences.
Contributing
Check out CONTRIBUTING.md to see how to develop with KubeVela.
Report Vulnerability
Security is a first priority thing for us at KubeVela. See SECURITY.md to report an issue privately, or send email directly to security@mail.kubevela.io.
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/condition
Package condition contains condition types +kubebuilder:object:generate=true
|
Package condition contains condition types +kubebuilder:object:generate=true |
|
core.oam.dev/v1alpha1
Package v1alpha1 contains resources relating to the Open Application Model.
|
Package v1alpha1 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. |
|
cmd
|
|
|
core
command
|
|
|
plugin
command
|
|
|
addon/mock
command
|
|
|
hack
|
|
|
crd/dispatch
command
|
|
|
docgen/cli
command
|
|
|
docgen/def
command
|
|
|
docgen/def/collect-translation
command
|
|
|
docgen/terraform
command
|
|
|
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/v1beta1/core/components
Package components provides components related controllers.
|
Package components provides components related controllers. |
|
controller/core.oam.dev/v1beta1/core/traits
Package traits provides traits related controllers.
|
Package traits provides traits related controllers. |
|
cue/cuex/providers/guardedhttp
Package guardedhttp is the vela/http CueX package with the outbound HTTP guard applied.
|
Package guardedhttp is the vela/http CueX package with the outbound HTTP guard applied. |
|
cue/upgrade
Package upgrade provides CUE version-compatibility helpers for KubeVela.
|
Package upgrade provides CUE version-compatibility helpers for KubeVela. |
|
definition
Package definition contains some helper functions used in vela CLI and vela addon mechanism
|
Package definition contains some helper functions used in vela CLI and vela addon mechanism |
|
definition/defkit
Package defkit provides a Go SDK for authoring KubeVela X-Definitions.
|
Package defkit provides a Go SDK for authoring KubeVela X-Definitions. |
|
definition/defkit/testing/matchers
Package matchers provides custom Gomega matchers for testing defkit definitions.
|
Package matchers provides custom Gomega matchers for testing defkit definitions. |
|
definition/goloader
Package goloader provides functionality to load and process Go-based KubeVela definitions.
|
Package goloader provides functionality to load and process Go-based KubeVela definitions. |
|
logging
Package logging provides structured logging utilities for KubeVela webhooks with focus on request traceability and observability.
|
Package logging provides structured logging utilities for KubeVela webhooks with focus on request traceability and observability. |
|
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. |
|
registry
Package registry provides a minimal interface-based provider registry for breaking import cycles in the codebase.
|
Package registry provides a minimal interface-based provider registry for breaking import cycles in the codebase. |
|
utils/kubeconfig
Package kubeconfig reports whether a Kubernetes client configuration can be resolved, without terminating the process when it cannot.
|
Package kubeconfig reports whether a Kubernetes client configuration can be resolved, without terminating the process when it cannot. |
|
utils/servingcert
Package servingcert keeps a self-signed CA and a serving cert for an in-cluster Service in a Secret, and renews them.
|
Package servingcert keeps a self-signed CA and a serving cert for an in-cluster Service in a Secret, and renews them. |
|
webhook/certs
Package certs sets up the serving cert of the vela-core admission webhooks.
|
Package certs sets up the serving cert of the vela-core admission webhooks. |
|
webhook/core.oam.dev/v1beta1/workflowstepdefinition
Package workflowstepdefinition provides admission control validation for WorkflowStepDefinition resources in KubeVela.
|
Package workflowstepdefinition provides admission control validation for WorkflowStepDefinition resources in KubeVela. |
|
references
|
|
|
cmd/cli
command
|
|
|
test
|
|