KubeVela Samples
These samples demonstrate how to ship applications through KubeVela. Each sample walks you through only a few steps required to ship an application super-quickly by KubeVela.
β οΈ Intended Audiences
KubeVela are designated to serve two typical kinds of users, one is the platform builder, the other is end-user of platform. Platform builders leverage KubeVela to develope PaaS platform (based on Kubernetes), while end-users consume the platform capabilities to ship or manage their applications through KubeVela. To avoid confusion and ambiguity, it's necessary to figure out which role you are playing and which role is the intended audience for the samples or any other documents about KubeVela.
β End-users are intended audiences for samples in this repository.
As an end-user, you should know below as prerequisite:
- basic concepts of KubeVela
- how to install KubeVela
- how to check detailed schema of a given capability
- everything about your own application (of course)
As an end-user, you should NOT worry about:
- how a capability works under the hood
- how to define a capability schema
- how to implement a capability
Above stuff is in the domain of platform builders.
Generic Steps To Ship An Application
No matter how complex the application is or how many operational characteristics the application needs, KubeVela only requires three steps for end-users to ship their applications, as significantly reduces the study cost and on-board difficulty for them.
- Determine Component Type
- Choose Traits For Components
- Assemble Components & Traits In Application
Each step will be explained and demonstrated in the samples.
Supported KubeVela version
KubeVela has released version 1.0 with numbers of powerful features and built-in capabilities. The master branch may include breaking changes, therefore ensure that you're running the samples with the right version of KubeVela. Samples in this repo is been tested with the current latest version (KubeVela-v1.0.3). Please install KubeVela as per the instructions here.
Samples
| Sample | Description |
|---|---|
| 1. hello-world | Demonstrates how to ship a simple python application. |
| 2. ServiceTracker App | This is an example microservices application with a Javascript Web UI, a MongoDB database, and a series of API microservices. The idea is that various app developers would create Components for their corresponding apps. The overall config will add traits and allow the app to be fully deployed |
| 3. BikeSharing 360 Multi Container App | This is an example microservices application with an ASP.NET Core Webform UI, and a series of API microservices. The idea is that various app developers would create Components for their corresponding apps. The overall config will add traits and allow the app to be fully deployed |
| 4. BikeSharing 360 Single Container App | Demonstrates KubeVela implementation of BikeSharing 360 app created in a Single Container. This sample has a single component and a configuration |
| 6. Knative App | Demonstrates how KubeVela integrates Knative Configuration/Route to deploy and manage applications. |
| 7. GoogleCloudPlatform MicroServices Demo | This is an example application consists of a 10-tier microservices application. The idea is that various app developers would create Workload for their corresponding apps. The overall config will add traits and allow the app to be fully deployed |
| 8. Terraform Demo | This is an example application to create an ECS, install Nginx and deploy a website in it |
| 9. GitOps Demo | This is an example to use KubeVela in a GitOps way. The example will show you how to update the config in Git repo to trigger automated re-deployment. |
| 10. Nocalhost Demo | This is an example to use KubeVela with Nocalhost. The example will show you how to debug in local environment with Nocalhost and KubeVela. |
| 11. Machine Learning Demo | This is an example to train and serve model with KubeVela. The example will show you how to use KubeVela AI addon. |
| 12. Multi-Cluster Demo | This is an example to KubeVela for managing and deploying application into multi-clusters. It includes the major features from version 1.3. |
| 13. ArgoCD Appfile Demo | This is an example to deploy application written in Appfile format using Argo CD. |
To get started with the samples, clone this repository and follow instructions in each sample:
git clone https://github.com/oam-dev/samples.git