From 488341398ae2c60f23715285fcb1f3b46feae85f Mon Sep 17 00:00:00 2001 From: yangsoon Date: Mon, 1 Mar 2021 20:25:18 +0800 Subject: [PATCH] fix:fix doc --- docs/en/concepts.md | 2 +- docs/en/cue/trait.md | 2 +- docs/en/install.md | 2 +- docs/en/platform-engineers/workload-type.md | 5 +++-- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/en/concepts.md b/docs/en/concepts.md index 8f3665c9b..9ed5eb6ae 100644 --- a/docs/en/concepts.md +++ b/docs/en/concepts.md @@ -66,7 +66,7 @@ We also reference workload type and trait as "application/capability modules" in ## Definitions -Both the schemas of workload settings and trait properties in `Application` are enforced by application modules that are pre-defined separately in a set of definition objects. The platform teams or component providers are responsible for registering and managing definitions in target cluster following [workload definition](https://github.com/oam-dev/spec/blob/master/4.workload_definitions.md) and [trait definition](https://github.com/oam-dev/spec/blob/master/6.traits.md) specifications in Open Application Model (OAM). +Both the schemas of workload settings and trait properties in `Application` are enforced by application modules that are pre-defined separately in a set of definition objects. The platform teams or component providers are responsible for registering and managing definitions in target cluster following [workload definition](https://github.com/oam-dev/spec/blob/master/4.workload_types.md) and [trait definition](https://github.com/oam-dev/spec/blob/master/6.traits.md) specifications in Open Application Model (OAM). Currently, KubeVela supports [CUE](https://github.com/cuelang/cue) as the module type in definitions, with more types such as Helm and Terraform are coming in following releases. In the case of Helm, a chart could be directly referenced as a component type in `Application` and its `values.yaml` will become the component's specification. diff --git a/docs/en/cue/trait.md b/docs/en/cue/trait.md index fd2934da8..8bf2793da 100644 --- a/docs/en/cue/trait.md +++ b/docs/en/cue/trait.md @@ -384,7 +384,7 @@ spec: containers: [{ name: context.name image: parameter.image - ports:[{containerPort: parameter.port}] + ports: [{containerPort: parameter.port}] envFrom: [{ configMapRef: name: context.name + "game-config" }] diff --git a/docs/en/install.md b/docs/en/install.md index a64df185b..84b16b75d 100644 --- a/docs/en/install.md +++ b/docs/en/install.md @@ -88,7 +88,7 @@ These steps will install KubeVela controller and its dependency. like `0.4.0-rc-master`. ```shell script - helm search repo kubevela/vela-core -l --devel + $ helm search repo kubevela/vela-core -l --devel NAME CHART VERSION APP VERSION DESCRIPTION kubevela/vela-core 0.4.0-rc-master 0.4.0-rc-master A Helm chart for KubeVela core kubevela/vela-core 0.3.2 0.3.2 A Helm chart for KubeVela core diff --git a/docs/en/platform-engineers/workload-type.md b/docs/en/platform-engineers/workload-type.md index 39e7de21e..cfb0d5a94 100644 --- a/docs/en/platform-engineers/workload-type.md +++ b/docs/en/platform-engineers/workload-type.md @@ -74,14 +74,15 @@ Note that OpenFaaS also requires a namespace and secret configured before first-
```bash +# create namespace +$ kubectl apply -f https://raw.githubusercontent.com/openfaas/faas-netes/master/namespaces.yml + # generate a random password $ PASSWORD=$(head -c 12 /dev/urandom | shasum| cut -d' ' -f1) $ kubectl -n openfaas create secret generic basic-auth \ --from-literal=basic-auth-user=admin \ --from-literal=basic-auth-password="$PASSWORD" - -$ kubectl apply -f https://raw.githubusercontent.com/openfaas/faas-netes/master/namespaces.yml ```