kubevela / samples Goto Github PK

KubeVela Samples Repository

Dockerfile 0.15% CSS 4.76% HTML 0.48% JavaScript 85.61% Vue 1.59% C# 0.71% Python 0.15% Go 0.14% SCSS 2.40% HCL 0.01% Makefile 0.01% Shell 0.01% CUE 4.01%

kubevela oam

samples's Introduction

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

samples's People

Contributors

Stargazers

Watchers

Forkers

vturecek adrienfromtoulouse suhuruli macolso sak0 wonderflow sudhakarkr sowsan iamsingularity hasheddan artursouza dacoppet handong890 ryanzhang-oss hongchaodeng niaoshuai zzxwill my-pleasure rllzyy waqasahmed0323 mottob xyzabi clix-dev-llc chivalryq captainroy-hy deephivemind fogdong fpy-oam-dev andybrier westwind027 songminglong ekmixon laashub-soa s4rd1nh4 onixus74 nemo-xue infine8 cpu6660 yue9944882 xubo245 sivanaikk ekochen xinqiji qlans barnettzqg hawk007 isabella232 devholic aastha22j02 daixy111040536 chengleqi wood-run ik-kubernetes lgtm-migrator zyhxq wuchengjiang fairhopeweb pieterjanpintens mackstone kushalhalder jzj lebronap satyazzz123 gfsxt1314 ik-kubernetes houming818 dorucioclea

samples's Issues

Migrate Helloworld sample to v1alpha2

child issue of #39

Rudr referenced in samples is deprecated and should be replaced by KubeVela

All samples test environment refer to Rudr which is deprecated and replaced in favor of KubeVela .

Samples should be retested with KubeVela and docs updated accordingly.

Sass tenant per namespace demo

Hi team,
I'm really interested in your effort with Kuvela.
I'm curious about applying the Kuvela model for Sass, tenant per K8S namespace.
Could you give me a suggestion? After that, I can contribute my sample project.

migrate all demos to v1alpha2

OAM v1alpha2 has released, some of demos have migrated and some are left.
We should migrate all of them to v1alpha2.

Helloworld #40
BikeSharing360_MultiContainer_App #41
BikeSharing360_SingleContainer_App #42

Hit two issue when ran sample "1.Helloworld"

Ran the sample https://github.com/oam-dev/samples/tree/master/1.Helloworld in Alibaba ACK cluster, I hit two issues.

Health check failed due to services "helloworld" not found.

✗ kubectl get svc
NAME         TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
helloworld   ClusterIP   172.16.137.106   <none>        8080/TCP   24m

Domain localhost host could be not visited.

➜  /Users/zhouzhengxi/Programming/golang/src/github.com/oam-dev/samples/1.Helloworld git:(master) ✗ k describe application first-app
Name:         first-app
Namespace:    default
Labels:       <none>
Annotations:  API Version:  core.oam.dev/v1beta1
Kind:         Application
Metadata:
  Creation Timestamp:  2021-05-14T07:53:50Z
  Generation:          2
  Managed Fields:
    API Version:  core.oam.dev/v1beta1
    Fields Type:  FieldsV1
    fieldsV1:
      f:metadata:
        f:annotations:
          .:
          f:kubectl.kubernetes.io/last-applied-configuration:
      f:spec:
        .:
        f:components:
    Manager:      k
    Operation:    Update
    Time:         2021-05-14T08:12:22Z
    API Version:  core.oam.dev/v1beta1
    Fields Type:  FieldsV1
    fieldsV1:
      f:status:
        .:
        f:components:
        f:conditions:
        f:latestRevision:
          .:
          f:name:
          f:revision:
          f:revisionHash:
        f:rollout:
          .:
          f:batchRollingState:
          f:currentBatch:
          f:lastTargetAppRevision:
          f:rollingState:
          f:upgradedReadyReplicas:
          f:upgradedReplicas:
        f:services:
        f:status:
    Manager:         kubevela
    Operation:       Update
    Time:            2021-05-14T08:13:17Z
  Resource Version:  80411761
  Self Link:         /apis/core.oam.dev/v1beta1/namespaces/default/applications/first-app
  UID:               a3ce4891-6b2b-49c0-890e-388214755003
Spec:
  Components:
    Name:  helloworld
    Properties:
      Env:
        Name:   TARGET
        Value:  KubeVela
      Image:    oamdev/helloworld-python:v1
      Port:     8080
    Traits:
      Properties:
        Domain:  localhost
        Http:
          /:  8080
      Type:   ingress
    Type:     webservice
Status:
  Components:
    API Version:  core.oam.dev/v1alpha2
    Kind:         Component
    Name:         helloworld
    UID:          a3ce4891-6b2b-49c0-890e-388214755003
  Conditions:
    Last Transition Time:  2021-05-14T07:53:50Z
    Reason:                Available
    Status:                True
    Type:                  Parsed
    Last Transition Time:  2021-05-14T07:53:50Z
    Reason:                Available
    Status:                True
    Type:                  Built
    Last Transition Time:  2021-05-14T07:53:51Z
    Reason:                Available
    Status:                True
    Type:                  Applied
    Last Transition Time:  2021-05-14T08:13:17Z
    Reason:                Available
    Status:                True
    Type:                  HealthCheck
  Latest Revision:
    Name:           first-app-v2
    Revision:       2
    Revision Hash:  18c3a8c9b7ba40d5
  Rollout:
    Batch Rolling State:
    Current Batch:             0
    Last Target App Revision:
    Rolling State:
    Upgraded Ready Replicas:   0
    Upgraded Replicas:         0
  Services:
    Healthy:  true
    Name:     helloworld
    Traits:
      Healthy:  true
      Message:  Visiting URL: localhost, IP: 47.243.62.107
      Type:     ingress
    Workload Definition:
      API Version:  apps/v1
      Kind:         Deployment
  Status:           running
Events:
  Type     Reason             Age                From         Message
  ----     ------             ----               ----         -------
  Normal   HealthChecked      39m (x3 over 39m)  Application  Health checked healthy
  Normal   Deployed           39m (x3 over 39m)  Application  Deployed successfully
  Normal   Rendered           21m (x6 over 39m)  Application  Rendered successfully
  Normal   FailedApply        21m (x6 over 39m)  Application  Applied successfully
  Warning  FailedHealthCheck  21m                Application  app=first-app, comp=helloworld, trait=ingress, check health error: get template context: failed to get obj helloworld with gvk /v1, Kind=Service : services "helloworld" not found

interesting samples

https://github.com/Xhofe/alist
https://github.com/gabrielecirulli/2048 images: evilroot/docker-2048

Migrate BikeSharing360_SingleContainer_App sample to v1alpha2

child issue of #39

Update the 2.ServiceTracker_App to match crosspane doc https://crossplane.io/docs/v0.11/

Current version of the installation needs some update:
a. The wording "Install either the local OAM addon following its instructions or install both Crossplane and remote OAM addon." sounds like a free choice.
It should lay out the scenarios, such as " if you deploy locally use OAM_local".
b. The links in the section "Infrastructure Operator: Install Crossplane" point the 0.9 version not 0.11.
c. The current crossplane provider database secret is called "alibaba-rdspostgresql-conn" under namespace "crossplane-system". The sample still uses "trackerdbconn" under "default".

Migrate BikeSharing360_MultiContainer_App sample to v1alpha2

child issue of #39

A end to end sample with OAM, Crossplane, Trait Injector and Serverless workload

Let's do a cool demo and verify some recent ideas.

Use OAM to define a Serverless Component (I choose Serverless so we don't need to define our own abstraction)
Define a database Component for it to consume, provisioned by ROS-OAM (other cloud could be backup)
Use Trait injector to inject credential. It's also a chance to verify Trait injector in this case. If it doesn't work, we need to re-think the design.

knative serving and OpenFaaS are best candidates. I'd suggest we start from knative, scaling could be a nice trait, eventing could be a nice Component, though those are non-goal for stage 1.

kubevela / samples Goto Github PK

samples's Introduction

KubeVela Samples

⚠️ Intended Audiences

Generic Steps To Ship An Application

Supported KubeVela version

Samples

samples's People

Contributors

Stargazers

Watchers

Forkers

samples's Issues

Recommend Projects

Recommend Topics

Recommend Org