Files
kubevela/docs/quick-start.md
2020-11-03 21:21:27 -08:00

117 lines
3.2 KiB
Markdown

# Quick Start
Welcome to KubeVela! In this guide, we'll walk you through how to deploy applications on KubeVela CLI/Appfile.
## Setup
Make sure you have finished and verified installation following [this guide](./install.md).
## 1. Initialize Application Deployment Config
```console
$ vela init --render-only
Welcome to use KubeVela CLI! We're going to help you run applications through a couple of questions.
Environment: default, namespace: default
? What is the domain of your application service (optional): example.com
? What is your email (optional, used to generate certification):
? What would you like to name your application (required): testapp
? Choose the workload type for your application (required, e.g., webservice): webservice
? What would you like to name this webservice (required): testsvc
? specify app image crccheck/hello-world
? specify port for container 8000
Deployment config is rendered and written to vela.yaml
```
In current directory, you will have a generated `vela.yaml`:
```yaml
createTime: ...
updateTime: ...
name: testapp
services:
testsvc:
type: webservice
image: crccheck/hello-world
port: 8000
route:
domain: testsvc.example.com
```
## 2. Deploy Application
```console
$ vela up
Parsing vela.yaml ...
Loading templates ...
Rendering configs for service (testsvc)...
Writing deploy config to (.vela/deploy.yaml)
Applying deploy configs ...
Checking if app has been deployed...
App has not been deployed, creating a new deployment...
✅ App has been deployed 🚀🚀🚀
Port forward: vela port-forward testapp
SSH: vela exec testapp
Logging: vela logs testapp
App status: vela status testapp
Service status: vela status testapp --svc testsvc
```
Check the status until we see route trait ready:
```console
$ vela status testapp
About:
Name: testapp
Namespace: default
Created at: ...
Updated at: ...
Services:
- Name: testsvc
Type: webservice
HEALTHY Ready: 1/1
Last Deployment:
Created at: ...
Updated at: ...
Routes:
- route: Visiting URL: http://testsvc.example.com IP: localhost
```
**In [kind cluster setup](../../install.md#kind)**, you can visit the service via localhost:
> If not in kind cluster, replace localhost with ingress address
```
$ curl -H "Host:testsvc.example.com" http://localhost/
<xmp>
Hello World
## .
## ## ## ==
## ## ## ## ## ===
/""""""""""""""""\___/ ===
~~~ {~~ ~~~~ ~~~ ~~~~ ~~ ~ / ===- ~~~
\______ o _,/
\ \ _,'
`'--.._\..--''
</xmp>
```
## What's Next
Congratulations! You have just deployed an app using Vela. Here are some recommended next steps:
- Learn about the project's [movation](./introduction.md) and [architecture](./design.md)
- Try out more [tutorials](./README.md)
- Join our community [Slack](https://cloud-native.slack.com/archives/C01BLQ3HTJA) and/or [Gitter](https://gitter.im/oam-dev/community)
Welcome onboard and sail Vela!