Config Template

    The config data save as a Secret default, but you also could generate resources of any type by defining the template. Even, you can define the extend writer to write the config data to the Nacos server.

    Config Template defined with the CUE file. The schema of the specification:

    • metadata.name This is required. Specify the name of the template.
    • metadata.alias Specify the alias of the template.
    • metadata.description Specify the description of the template.
    • metadata.scope Specify the scope of the config created by this template. In VelaUX, the template belonging to the project scope means this template could be used to create the config in the project. If created in the system, this config could be shared with all projects.
    • metadata.sensitive Is it sensitive the config created by this template? If the config is sensitive, it can not be read directly and could only mount the Secret.

    Template

    • template.output This is not required. You could specify if you want to customize the data structure of the Secret.

    • template.outputs This is not required. You could specify any resources that you want to generate by this config.

    • List the Config Templates
    1. vela config-template list
    • Create a Config Template
    1. vela config-template apply -f example.cue
    • Show the schema and document of the Config Template
    • Delete a Config Template
    1. vela config-template delete <Template Name>

    More usages, refer to:

    1. vela config-template --help

    Nacos Server

    1. metadata: {
    2.     name:        "nacos-server"
    3.     alias:       "Nacos Server"
    4.     description: "Config the Nacos server connectors"
    5.     sensitive:   false
    6.     scope:       "system"
    7. }
    9. template: {
    10.     parameter: {
    11.         // +usage=Directly configure the Nacos server address
    12.         servers?: [...{
    13.             ipAddr: string
    14.             // +usage=nacos server port
    15.             port: *8849 | int
    16.             // +usage=nacos server grpc port, default=server port + 1000, this is not required
    17.             grpcPort?: int
    18.         }]
    20.         client?: {
    21.             // +usage=the endpoint for get Nacos server addresses
    22.             endpoint: string
    23.             // +usage=the AccessKey for kms
    24.             accessKey?: string
    25.             // +usage=the SecretKey for kms
    26.             secretKey?: string
    27.             // +usage=the regionId for kms
    28.             regionId?: string
    29.             // +usage=the username for nacos auth
    30.             username?: string
    31.             // +usage=the password for nacos auth
    32.             password?: string
    33.             // +usage=it's to open kms,default is false. https://help.aliyun.com/product/28933.html
    34.             openKMS?: bool
    35.         }
    36.     }
    37. }
    1. metadata: {
    2.     name:        "nacos-config"
    3.     alias:       "Nacos Configuration"
    4.     description: "Write the configuration to the nacos"
    5.     sensitive:   false
    6.     scope:       "system"
    7. }
    9. template: {
    10.     nacos: {
    11.         // The endpoint can not references the parameter.
    12.         endpoint: {
    13.             // Users must create a config base the nacos-server template firstly.
    14.             name: "nacos"
    15.         }
    17.         // could references the parameter
    19.             dataId: parameter.dataId
    20.             group:  parameter.group
    21.             if parameter.appName != _|_ {
    22.                 appName: parameter.appName
    23.             }
    24.             if parameter.namespaceId != _|_ {
    25.                 namespaceId: parameter.namespaceId
    26.             }
    27.             if parameter.tenant != _|_ {
    28.                 tenant: parameter.tenant
    29.             }
    30.             if parameter.tag != _|_ {
    31.                 tag: parameter.tag
    32.             }
    33.         }
    34.         content: parameter.content
    35.     }
    36.     parameter: {
    37.         // +usage=Configuration ID
    38.         dataId: string
    39.         // +usage=Configuration group
    40.         group: *"DEFAULT_GROUP" | string
    41.         // +usage=The configuration content.
    42.         content: {
    43.             ...
    44.         }
    45.         contentType: *"json" | "yaml" | "properties" | "toml"
    46.         // +usage=The app name of the configuration
    47.         appName?: string
    48.         // +usage=The namespaceId of the configuration
    49.         namespaceId?: string
    50.         // +usage=The tenant, corresponding to the namespace ID field of Nacos
    51.         tenant?: string
    52.         // +usage=The tag of the configuration
    53.         tag?: string
    54.     }

    Alibaba Cloud Provider

    The Config Template is part of the . You could get or share the templates via addons.