Version: v1.0

Overview

To achieve best user experience for your platform, we recommend platform builders to create simple and user friendly UI for end users instead of exposing full platform level details to them. Some common practices include building GUI console, adopting DSL, or creating a user friendly command line tool.

As an proof-of-concept of building developer experience with KubeVela, we developed a client-side tool named Appfile as well. This tool enables developers to deploy any application with a single file and a single command: vela up.

Now let’s walk through its experience.

Step 1: Install

Make sure you have finished and verified the installation following this guide.

Step 2: Deploy Your First Application

  1. $ vela up -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/vela.yaml
  2. Parsing vela.yaml ...
  3. Loading templates ...
  6. Rendering configs for service (testsvc)...
  7. Writing deploy config to (.vela/deploy.yaml)
  10. Applying deploy configs ...
  11. Checking if app has been deployed...
  12. App has not been deployed, creating a new deployment...
  13. ✅ App has been deployed 🚀🚀🚀
  14.     Port forward: vela port-forward first-vela-app
  15.              SSH: vela exec first-vela-app
  16.          Logging: vela logs first-vela-app
  17.       App status: vela status first-vela-app
  18.   Service status: vela status first-vela-app --svc testsvc

Check the status until we see Routes are ready:

  1. $ vela status first-vela-app
  2. About:
  5.   Name:       first-vela-app
  6.   Namespace:  default
  7.   Created at: ...
  8.   Updated at: ...
  11. Services:
  14.   - Name: testsvc
  15.     Type: webservice
  16.     HEALTHY Ready: 1/1
  17.     Last Deployment:
  18.       Created at: ...
  19.       Updated at: ...
  20.     Traits:
  21.       - ✅ ingress: Visiting URL: testsvc.example.com, IP: <your IP address>

In kind cluster setup, you can visit the service via localhost. In other setups, replace localhost with ingress address accordingly.

  1. $ curl -H "Host:testsvc.example.com" http://localhost/
  2. <xmp>
  3. Hello World
  8.                                        ##         .
  9.                                  ## ## ##        ==
  10.                               ## ## ## ## ##    ===
  11.                            /""""""""""""""""\___/ ===
  12.                       ~~~ {~~ ~~~~ ~~~ ~~~~ ~~ ~ /  ===- ~~~
  13.                            \______ o          _,/
  14.                             \      \       _,'
  15.                              `'--.._\..--''
  16. </xmp>

Voila! You are all set to go.

What’s Next

  • Learn details about Appfile and know how it works.