diff --git a/README.md b/README.md index cd2a630ae..a04cfb20e 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ KubeVela is the platform engine to create *PaaS-like* experience on Kubernetes, - Slack: [CNCF Slack](https://slack.cncf.io/) #kubevela channel - Gitter: [Discussion](https://gitter.im/oam-dev/community) -> NOTE: KubeVela is still in early stage and iterating quickly. It's currently under preview release. +> NOTE: KubeVela is still iterating quickly. It's currently under pre-beta release. ## Installation @@ -35,8 +35,16 @@ Quick start is available on [this section](https://kubevela.io/#/en/quick-start) For full documentation, please visit the KubeVela website: [https://kubevela.io](https://kubevela.io/). +## Talks and Conferences + +| Engagement | Link | +|:-----------|:------------| +| 🎤 Talks | - [KubeVela - The Modern App Delivery System in Alibaba](https://docs.google.com/presentation/d/1CWCLcsKpDQB3bBDTfdv2BZ8ilGGJv2E8L-iOA5HMrV0/edit?usp=sharing) | +| 🌎 KubeCon | - [ [NA 2020] Standardizing Cloud Native Application Delivery Across Different Clouds](https://www.youtube.com/watch?v=0yhVuBIbHcI)
- [ [EU 2021] Zero Pain Microservice Development and Deployment with Dapr and KubeVela](https://sched.co/iE4S) | +| 📺 Conferences | - [Dapr, Rudr, OAM: Mark Russinovich presents next gen app development & deployment](https://www.youtube.com/watch?v=eJCu6a-x9uo)
- [Mark Russinovich presents "The Future of Cloud Native Applications with OAM and Dapr"](https://myignite.techcommunity.microsoft.com/sessions/82059)| + ## Contributing Check out [CONTRIBUTING](./CONTRIBUTING.md) to see how to develop with KubeVela. ## Code of Conduct -KubeVela adopts [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE OF CONDUCT](CODE_OF_CONDUCT.md) for details. +KubeVela adopts [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md index 6ac2ff0c7..35bfe8648 100644 --- a/docs/en/_sidebar.md +++ b/docs/en/_sidebar.md @@ -1,97 +1,87 @@ - Overview - [Introduction](/en/introduction.md) + - [Core Concepts](/en/concepts.md) - Getting Started - [Installation](/en/install.md) - [Quick Start](/en/quick-start.md) -- Learning KubeVela - - [Core Concepts](/en/concepts.md) - - Application - - [Overview](/en/platform-engineers/overview.md) - - [Define Application](/en/application.md) - - Components and Traits - - [Overview](/en/platform-engineers/definition-and-templates.md) - - CUE - - [CUE Basic](/en/cue/basic.md) - - [Define Components](/en/cue/workload-type.md) - - [Define Traits](/en/cue/trait.md) - - [Advanced Features](/en/cue/status.md) - - Helm - - [Define Components](/en/helm/component.md) - - [Attach Traits](/en/helm/trait.md) - - [Known Limitations](/en/helm/known-issues.md) - - - - +- Application Abstraction + - [Overview](/en/platform-engineers/overview.md) + - [Application CRD](/en/application.md) + - [Definition CRD](/en/platform-engineers/definition-and-templates.md) -- Building Developer Experience +- Using CUE + - [Learning CUE](/en/cue/basic.md) + - [Define Components](/en/cue/workload-type.md) + - [Define Traits](/en/cue/trait.md) + - [Advanced Features](/en/cue/status.md) + - [Auto-generated Schema](/en/platform-engineers/openapi-v3-json-schema.md) + +- Using Helm + - [Define Components](/en/helm/component.md) + - [Attach Traits](/en/helm/trait.md) + - [Known Limitations](/en/helm/known-issues.md) + +- Developer Experience - [Overview](/en/quick-start-appfile.md) - - [Appfile](/en/developers/learn-appfile.md) - - CLI - - Debugging - - [Port Forwarding](/en/developers/port-forward.md) - - [Check Application Logs](/en/developers/check-logs.md) - - [Execute Commands in Container](/en/developers/exec-cmd.md) - - Extending - - [Managing Capabilities](/en/developers/cap-center.md) - - [Setting Routes](/en/developers/extensions/set-route.md) - - [Setting Auto-scaling Policy](/en/developers/extensions/set-autoscale.md) - - [Setting Rollout Strategy](/en/developers/extensions/set-rollout.md) - - [Setting Monitoring Policy](/en/developers/extensions/set-metrics.md) - - Configuring - - [Setting Up Deployment Environment](/en/developers/config-enviroments.md) - - [Configuring data/env in Application](/en/developers/config-app.md) - + - [Learning Appfile](/en/developers/learn-appfile.md) + - [Port Forwarding](/en/developers/port-forward.md) + - [Check Application Logs](/en/developers/check-logs.md) + - [Execute Commands in Container](/en/developers/exec-cmd.md) + - [Managing Capabilities](/en/developers/cap-center.md) + - [Setting Routes](/en/developers/extensions/set-route.md) + - [Setting Auto-scaling Policy](/en/developers/extensions/set-autoscale.md) + - [Setting Rollout Strategy](/en/developers/extensions/set-rollout.md) + - [Setting Monitoring Policy](/en/developers/extensions/set-metrics.md) + - [Setting Up Deployment Environment](/en/developers/config-enviroments.md) + - [Configuring data/env in Application](/en/developers/config-app.md) + + + + + + +- CLI References + - [vela config](/en/cli/vela_config.md) + - [vela env](/en/cli/vela_env.md) + - [vela init](/en/cli/vela_init.md) + - [vela install](/en/cli/vela_install.md) + - [vela up](/en/cli/vela_up.md) + - [vela version](/en/cli/vela_version.md) + - [vela delete](/en/cli/vela_delete.md) + - [vela exec](/en/cli/vela_exec.md) + - [vela logs](/en/cli/vela_logs.md) + - [vela ls](/en/cli/vela_ls.md) + - [vela port-forward](/en/cli/vela_port-forward.md) + - [vela show](/en/cli/vela_show.md) + - [vela status](/en/cli/vela_status.md) + - [vela svc](/en/cli/vela_svc.md) + - [vela workloads](/en/cli/vela_workloads.md) + - [vela traits](/en/cli/vela_traits.md) + - [vela scaler](/en/cli/vela_scaler.md) + - [vela route](/en/cli/vela_route.md) + - [vela autoscale](/en/cli/vela_autoscale.md) + - [vela rollout](/en/cli/vela_rollout.md) + - [vela metrics](/en/cli/vela_metrics.md) + - [vela completion](/en/cli/vela_completion.md) + - [vela dashboard](/en/cli/vela_dashboard.md) + - [vela system](/en/cli/vela_system.md) + - [vela template](/en/cli/vela_template.md) + - [vela cap](/en/cli/vela_cap.md) + +- [Capability References](/en/developers/references/README.md) + - [Web Service](/en/developers/references/workload-types/webservice.md) + - [Task](/en/developers/references/workload-types/task.md) + - [Worker](/en/developers/references/workload-types/worker.md) + - [Route](/en/developers/references/traits/route.md) + - [Autoscale](/en/developers/references/traits/autoscale.md) + - [Rollout](/en/developers/references/traits/rollout.md) + - [Metrics](/en/developers/references/traits/metrics.md) + - [Scaler](/en/developers/references/traits/scaler.md) + - [Restful API](/en/developers/references/restful-api/index.html ':ignore') - Roadmap - [KubeVela Roadmap](/en/roadmap.md) -- References - - [Capabilities](/en/developers/references/README.md) - - Workload Types - - [Web Service](/en/developers/references/workload-types/webservice.md) - - [Task](/en/developers/references/workload-types/task.md) - - [Worker](/en/developers/references/workload-types/worker.md) - - Traits - - [Route](/en/developers/references/traits/route.md) - - [Autoscale](/en/developers/references/traits/autoscale.md) - - [Rollout](/en/developers/references/traits/rollout.md) - - [Metrics](/en/developers/references/traits/metrics.md) - - [Scaler](/en/developers/references/traits/scaler.md) - - [Restful API](/en/developers/references/restful-api/index.html ':ignore') - - CLI - - General - - [vela config](/en/cli/vela_config.md) - - [vela env](/en/cli/vela_env.md) - - [vela init](/en/cli/vela_init.md) - - [vela install](/en/cli/vela_install.md) - - [vela up](/en/cli/vela_up.md) - - [vela version](/en/cli/vela_version.md) - - Applications - - [vela delete](/en/cli/vela_delete.md) - - [vela exec](/en/cli/vela_exec.md) - - [vela logs](/en/cli/vela_logs.md) - - [vela ls](/en/cli/vela_ls.md) - - [vela port-forward](/en/cli/vela_port-forward.md) - - [vela show](/en/cli/vela_show.md) - - [vela status](/en/cli/vela_status.md) - - [vela svc](/en/cli/vela_svc.md) - - Workload Types - - [vela workloads](/en/cli/vela_workloads.md) - - Traits - - [vela traits](/en/cli/vela_traits.md) - - [vela scaler](/en/cli/vela_scaler.md) - - [vela route](/en/cli/vela_route.md) - - [vela autoscale](/en/cli/vela_autoscale.md) - - [vela rollout](/en/cli/vela_rollout.md) - - [vela metrics](/en/cli/vela_metrics.md) - - System - - [vela completion](/en/cli/vela_completion.md) - - [vela dashboard](/en/cli/vela_dashboard.md) - - [vela system](/en/cli/vela_system.md) - - [vela template](/en/cli/vela_template.md) - - Extensibility - - [vela cap](/en/cli/vela_cap.md) - [FAQ](/en/developers/references/devex/faq.md) diff --git a/docs/en/application.md b/docs/en/application.md index ac844f513..90f820874 100644 --- a/docs/en/application.md +++ b/docs/en/application.md @@ -1,6 +1,6 @@ -# Defining Application +# Using `Application` to Describe Your App -This documentation will walk through how to use `Application` object to define your application with corresponding operational behaviors in declarative approach. +This documentation will walk through how to use `Application` object to define your apps with corresponding operational behaviors in declarative approach. ## Example diff --git a/docs/en/concepts.md b/docs/en/concepts.md index b8c5b70a8..00cd86bb0 100644 --- a/docs/en/concepts.md +++ b/docs/en/concepts.md @@ -96,8 +96,3 @@ The overall architecture of KubeVela is shown as below: ![alt](../../resources/arch.png) Specifically, the application controller is responsible for application abstraction and encapsulation (i.e. the controller for `Application` and `Definition`). The rollout controller will handle progressive rollout strategy with the whole application as a unit. The multi-env deployment engine (*currently WIP*) is responsible for deploying the application across multiple clusters and environments. - - -## What's Next - -Now that you have grasped the core ideas of KubeVela, let's learn more details about [Application CRD](platform-engineers/overview.md) feature. diff --git a/docs/en/cue/basic.md b/docs/en/cue/basic.md index b2c551c75..116f37b0a 100644 --- a/docs/en/cue/basic.md +++ b/docs/en/cue/basic.md @@ -1,4 +1,4 @@ -# CUE Basic +# Learning CUE This document will explain how to use [CUE](https://cuelang.org/) to encapsulate a given capability in Kubernetes and make it available to end users to consume in `Application` CRD. Please make sure you have already learned about `Application` custom resource before reading the following guide. diff --git a/docs/en/platform-engineers/overview.md b/docs/en/platform-engineers/overview.md index b6e747903..4b14b98be 100644 --- a/docs/en/platform-engineers/overview.md +++ b/docs/en/platform-engineers/overview.md @@ -22,22 +22,22 @@ metadata: spec: components: - name: foo - type: worker # workload type + type: webservice settings: - image: "busybox" - cmd: - - sleep - - "1000" + image: crccheck/hello-world + port: 8000 traits: - - name: scaler + - name: ingress properties: - replicas: 10 + domain: testsvc.example.com + http: + "/": 8000 - name: sidecar properties: - name: "sidecar-test" - image: "nginx" + name: "logging" + image: "fluentd" - name: bar - type: aliyun-oss # workload type + type: aliyun-oss # cloud service bucket: "my-bucket" ``` diff --git a/docs/resources/arch.png b/docs/resources/arch.png index 0816fee97..bb0efcff7 100644 Binary files a/docs/resources/arch.png and b/docs/resources/arch.png differ