Files
kubevela/docs/examples/config/image-registry
Jianbo Sun b24e7523d8 Feat: generate docs for reference automatically (#4377)
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Feat: refactor hardcode example to embd.FS

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: refactor doc gen for general types

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: update generate format

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: generate terraform reference docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Feat: add definition reference generate script

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: refine output format

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: remove dup annotation

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: update doc

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: add i18n support

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Feat: add translation

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Feat: add policy definition gen

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: add compatibility for lable Annotation change

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: add more tests

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Feat: allow mark example doc url on annotation

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

Fix: align vela show with vela def doc-gen, add vela def show equals with vela show

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2022-07-18 19:22:55 +08:00
..

How to store and use configurations

General

  • list all configuration types. Note before vela v1.5, the key is "custom.definition.oam.dev/catalog.config.oam.dev"
$ vela components --label catalog.config.oam.dev=velacore-config
NAME                  	DEFINITION
config-dex-connector  	autodetects.core.oam.dev
config-helm-repository	autodetects.core.oam.dev
config-image-registry 	autodetects.core.oam.dev
terraform-azure       	autodetects.core.oam.dev
terraform-baidu       	autodetects.core.oam.dev
# Get http://127.0.0.1:8000/api/v1/configs

[
 {
  "definitions": [
   "config-dex-connector"
  ],
  "name": "Dex Connectors",
  "type": "dex-connector"
 },
 {
  "definitions": [
   "config-helm-repository"
  ],
  "name": "Helm Repository",
  "type": "helm-repository"
 },
 {
  "definitions": [
   "config-image-registry"
  ],
  "name": "Image Registry",
  "type": "image-registry"
 },
 null,
 {
  "definitions": [
   "terraform-baidu"
  ],
  "name": "Terraform Cloud Provider",
  "type": "terraform-provider"
 }
]
  • list all configurations
$ kubectl get secret -n vela-system -l=config.oam.dev/catalog=velacore-config
NAME                 TYPE                             DATA   AGE
image-registry-dev   kubernetes.io/dockerconfigjson   1      3h51m

Image registry

  • Create a config for an image registry
$ vela up -f app-config-image-registry-account-auth.yaml
Applying an application in vela K8s object format...
I0323 10:45:25.347102   85930 apply.go:107] "creating object" name="config-image-registry-account-auth-dev" resource="core.oam.dev/v1beta1, Kind=Application"
✅ App has been deployed 🚀🚀🚀
    Port forward: vela port-forward config-image-registry-account-auth-dev
             SSH: vela exec config-image-registry-account-auth-dev
         Logging: vela logs config-image-registry-account-auth-dev
      App status: vela status config-image-registry-account-auth-dev
        Endpoint: vela status config-image-registry-account-auth-dev
 --endpoint%
 
 
$ kubectl get secret -n vela-system -l=config.oam.dev/catalog=velacore-config
NAME                 TYPE                             DATA   AGE
image-registry-dev   kubernetes.io/dockerconfigjson   1      77s
  • Deliver the config secret to working cluster
$ vela cluster list
CLUSTER	TYPE           	ENDPOINT                  	ACCEPTED	LABELS
local  	Internal       	-                         	true
bj     	X509Certificate	https://123.57.73.107:6443	true

$ vela up -f app-deliever-secret.yaml
  • Deploy an application who needs to pull images from the private image registry
$ export KUBECONFIG=~/.kube/config-bj
$ kubectl get secret -n vela-system -l=config.oam.dev/catalog=velacore-config
NAME                 TYPE                             DATA   AGE
image-registry-dev   kubernetes.io/dockerconfigjson   1      120s

$ vela up -f app-validate-imagePullSecret.yaml