Adding Component Configuration

Function

This API is used to add component configuration.

URI

POST /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. Maximum characters: 16,384
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or set to 0, resources in the default enterprise project are queried. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

Response Parameters

None

Example Request

• Configure an RDS database: Set the database name to cae, address to 100.xx.xx.xxx, and port number to 3306.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "rds",
      "data" : {
        "spec" : {
          "rds_id" : "a5fdee4cf88c4277a68688a014f444bdin01",
          "rds_db_name" : "cae",
          "rds_address" : "100.xx.xx.xxx",
          "rds_username" : "cae",
          "rds_password" : "xxx",
          "rds_port" : "3306"
        }
      }
    } ]
  }
• Configure CSE addresses: Set the configuration center addresses to https://192.168.1.xxx:30103,https://192.168.1.xxx:30103, and the service registration and discovery addresses to https://192.168.1.xxx:30100,https://192.168.1.xxx:30100.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "cse",
      "data" : {
        "spec" : {
          "config_center_addr" : "https://192.168.1.xxx:30103,https://192.168.1.xxx:30103",
          "service_center_addr" : "https://192.168.1.xxx:30100,https://192.168.1.xxx:30100",
          "cse_id" : "25779525-1aac-44be-abda-f9164f1b41b8"
        }
      }
    } ]
  }
• Create an environment variable component configuration: Set the time zone to Asia/Shanghai, and inject a secret named password as the environment variable.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "env",
      "data" : {
        "spec" : {
          "envs" : {
            "TZ" : "Asia/Shanghai"
          },
          "env_references" : {
            "env_name" : "db_password",
            "value_from" : {
              "name" : "password",
              "reference_type" : "dewSecret"
            }
          }
        }
      }
    } ]
  }
• Configure private and public network access:
  • Set the private network access mode to ClusterIP, listening port number to 80, access port number to 8080, and protocol to TCP.
  • Set the public network access mode to LoadBalancer, listening port number to 80, access port number to 9090, and protocol to TCP. Configure a whitelist to allow access from 170.126.0.0/16.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "access",
      "data" : {
        "spec" : {
          "items" : [ {
            "type" : "ClusterIP",
            "ports" : [ {
              "target_port" : 80,
              "port" : 8080,
              "protocol" : "TCP"
            } ]
          }, {
            "type" : "LoadBalancer",
            "access_control" : {
              "type" : "white",
              "ip_list" : [ "170.126.0.0/16" ]
            },
            "elb_id" : "xxx",
            "ports" : [ {
              "target_port" : 80,
              "port" : 9090,
              "protocol" : "TCP"
            } ]
          } ]
        }
      }
    } ]
  }
• Configure two forwarding policies for public network access: Set the protocol to HTTPS, retain the default load balancing policy (weighted round robin algorithm), set the access port number to 8443, configure a blacklist to deny access from 10.120.1.1 and 10.120.1.2, set the security policy to tls-1-2-strict, and retain the default server certificate test.
  • For the first forwarding policy, set the domain name to test.example.com, URL match mode to STARTS_WITH, path to /test1, and listening port number to 80, and use the default certificate test.
  • For the second forwarding policy, set the domain name to test.example.cn, URL match mode to STARTS_WITH, path to /test2, listening port number to 80, and certificate to test1.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "access",
      "data" : {
        "spec" : {
          "items" : [ {
            "type" : "Ingress",
            "access_control" : {
              "type" : "black",
              "ip_list" : [ "10.120.1.1", "10.120.1.2" ]
            },
            "ports" : [ {
              "port" : 8443,
              "protocol" : "HTTPS",
              "default_certificate" : "test",
              "policy" : "tls-1-2-strict",
              "target_port" : 80,
              "paths" : [ {
                "path" : "/test1",
                "url_match_mode" : "STARTS_WITH",
                "hostname" : "test.example.com"
              } ]
            }, {
              "port" : 8443,
              "protocol" : "HTTPS",
              "default_certificate" : "test",
              "certificate" : "test1",
              "policy" : "tls-1-2-strict",
              "target_port" : 80,
              "paths" : [ {
                "path" : "/test2",
                "url_match_mode" : "STARTS_WITH",
                "hostname" : "test.example.cn"
              } ]
            } ]
          } ]
        },
        "metadata" : {
          "annotations" : {
            "kubernetes.io/elb.health-check-flag" : "off",
            "kubernetes.io/elb.lb-algorithm" : "ROUND_ROBIN"
          }
        }
      }
    } ]
  }
• Create an AS policy: Set max_replica_count to 3, min_replica_count to 1, CPU usage to 30%, memory usage to 30%, and scaledown_stabilization_seconds to 300 (5 minutes), scaledown_rate to 99, scaleup_rate to 4, and disable_scaledown to false.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "scaling",
      "data" : {
        "spec" : {
          "scale_strategy" : "metric",
          "max_replica_count" : 3,
          "min_replica_count" : 1,
          "advanced" : {
            "scaledown_stabilization_seconds" : 300,
            "scaledown_rate" : 99,
            "scaleup_stabilization_seconds" : 0,
            "scaleup_rate" : 4,
            "disable_scaledown" : false
          },
          "triggers" : [ {
            "metadata" : {
              "type" : "Utilization",
              "value" : "30"
            },
            "type" : "cpu"
          }, {
            "metadata" : {
              "type" : "Utilization",
              "value" : "30"
            },
            "type" : "memory"
          } ]
        }
      }
    } ]
  }
• Configure cloud storage (OBS bucket or OBS parallel file system): For an object bucket, set the mount path to /tmp and permission to ReadWriteMany. For a parallel file system, set the mount path to /temp and permission to ReadWriteMany.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "volume",
      "data" : {
        "spec" : {
          "volumes" : [ {
            "volume_id" : "bef119d0-c7d1-4b58-9794-8b74faf80a59",
            "resource_name" : "test-nacos",
            "resource_type" : "obs",
            "resource_sub_type" : "object_bucket",
            "umask" : "0027",
            "mount_info" : [ {
              "path" : "/tmp",
              "access_mode" : "ReadWriteMany"
            } ]
          }, {
            "mount_info" : [ {
              "path" : "/temp",
              "access_mode" : "ReadWriteMany"
            } ],
            "volume_id" : "a061934d-52e3-4b36-aea7-6c51879f84c9",
            "resource_name" : "test",
            "resource_type" : "obs",
            "resource_sub_type" : "parallel_file_system",
            "umask" : "0027"
          } ]
        }
      }
    } ]
  }
• Configure health check, including configuring a liveness probe, readiness probe, and startup probe.
  • Configure a liveness probe: Set the type to livenessProbe, detection period to 10s, latency to 1s, timeout to 1s, success threshold to 1, failure threshold to 3, port number to 80, and protocol to HTTP. Leave the path and request header blank.
  • Configure a readiness probe: Set the type to readinessProbe, detection period to 10s, latency to 0s (if the value is 0, it is optional to transfer this parameter), timeout to 1s, success threshold to 1, failure threshold to 3, port number to 80, and protocol to HTTP. Leave the path and request header blank.
  • Configure a startup probe: Set the type to startupProbe, detection period to 10s, latency to 0s (if the value is 0, it is optional to transfer this parameter), timeout to 1s, success threshold to 1, failure threshold to 3, port number to 80, protocol to HTTP, and request header to x-auth-token. Leave the path blank.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "healthCheck",
      "data" : {
        "spec" : {
          "livenessProbe" : {
            "periodSeconds" : 10,
            "initialDelaySeconds" : 1,
            "timeoutSeconds" : 1,
            "successThreshold" : 1,
            "failureThreshold" : 3,
            "httpGet" : {
              "path" : "",
              "port" : 80,
              "httpHeaders" : [ ],
              "scheme" : "HTTP"
            }
          },
          "startupProbe" : {
            "periodSeconds" : 10,
            "timeoutSeconds" : 1,
            "successThreshold" : 1,
            "failureThreshold" : 3,
            "httpGet" : {
              "path" : "",
              "port" : 80,
              "httpHeaders" : [ {
                "name" : "x-auth-token",
                "value" : "xxx"
              } ],
              "scheme" : "HTTP"
            }
          },
          "readinessProbe" : {
            "periodSeconds" : 10,
            "timeoutSeconds" : 1,
            "successThreshold" : 1,
            "failureThreshold" : 3,
            "httpGet" : {
              "path" : "",
              "port" : 80,
              "httpHeaders" : [ ],
              "scheme" : "HTTP"
            }
          }
        }
      }
    } ]
  }
• Configure lifecycle management (such as post-startup and pre-stop processing). Configure the post-startup command /bin/sh -c "echo service start" and the pre-stop command /bin/sh -c "echo service end".

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "lifecycle",
      "data" : {
        "spec" : {
          "postStart" : {
            "exec" : {
              "command" : [ "/bin/sh", "-c", "echo service start" ]
            }
          },
          "preStop" : {
            "exec" : {
              "command" : [ "/bin/sh", "-c", "echo service end" ]
            }
          }
        }
      }
    } ]
  }
• Configure custom log collection: Specify path /var/log/error.log to collect logs.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "log",
      "data" : {
        "spec" : {
          "log_paths" : [ "/var/log/error.log" ]
        }
      }
    } ]
  }
• Configure performance management: Set instrumentation to automatic.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "apm2",
      "data" : {
        "spec" : {
          "instrumentation" : "automatic"
        }
      }
    } ]
  }
• Configure custom metric monitoring: Set the collection path to /metrics and port to 2112, and specify custom metric myapp_processed_ops_total.

  POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations
  
  {
    "api_version" : "v1",
    "kind" : "ComponentConfiguration",
    "items" : [ {
      "type" : "customMetric",
      "data" : {
        "spec" : {
          "path" : "/metrics",
          "port" : 2112,
          "metrics" : [ "myapp_processed_ops_total" ]
        }
      }
    } ]
  }

Example Response

None

Status Code

Error Code

For details, see Error Codes.