Installing an Add-on Instance

Function

This API is used to install an add-on instance using an add-on template.

Calling Method

For details, see Calling APIs.

URI

POST /autopilot/v3/addons

Request Parameters

Response Parameters

Status code: 201

Example Requests

Install CoreDNS 1.28.6 and set the number of add-on pods to 2.

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "metadata" : {
    "annotations" : {
      "addon.install/type" : "install"
    }
  },
  "spec" : {
    "clusterID" : "597f2d95-44ab-11ef-9e39-0255ac100115",
    "version" : "1.28.6",
    "addonTemplateName" : "coredns",
    "values" : {
      "basic" : {
        "cluster_ip" : "10.247.3.10",
        "image_version" : "1.28.6",
        "swr_addr" : "swr.cn-north-7.myhuaweicloud.com",
        "swr_user" : "autopilot-official",
        "rbac_enabled" : true,
        "cluster_version" : "v1.28"
      },
      "flavor" : {
        "category" : [ "Autopilot" ],
        "is_default" : true,
        "name" : "autopilot-flavor1",
        "replicas" : 2,
        "resources" : [ {
          "id" : "coredns",
          "name" : "coredns",
          "limitsCpu" : "1000m",
          "requestsCpu" : "1000m",
          "limitsMem" : "2048Mi",
          "requestsMem" : "2048Mi"
        } ]
      },
      "custom" : {
        "multiAZBalance" : false,
        "multiAZEnabled" : false,
        "node_match_expressions" : [ ],
        "parameterSyncStrategy" : "ensureConsistent",
        "servers" : [ {
          "plugins" : [ {
            "name" : "bind",
            "parameters" : "{$POD_IP}"
          }, {
            "configBlock" : "servfail 5s",
            "name" : "cache",
            "parameters" : 30
          }, {
            "name" : "errors"
          }, {
            "name" : "health",
            "parameters" : "{$POD_IP}:8080"
          }, {
            "name" : "ready",
            "parameters" : "{$POD_IP}:8081"
          }, {
            "configBlock" : "pods insecure\nfallthrough in-addr.arpa ip6.arpa",
            "name" : "kubernetes",
            "parameters" : "cluster.local in-addr.arpa ip6.arpa"
          }, {
            "name" : "loadbalance",
            "parameters" : "round_robin"
          }, {
            "name" : "prometheus",
            "parameters" : "{$POD_IP}:9153"
          }, {
            "configBlock" : "policy random",
            "name" : "forward",
            "parameters" : ". /etc/resolv.conf"
          }, {
            "name" : "reload"
          } ],
          "port" : 5353,
          "zones" : [ {
            "zone" : "."
          } ]
        } ],
        "stub_domains" : { },
        "tolerations" : [ {
          "key" : "node.kubernetes.io/not-ready",
          "operator" : "Exists",
          "effect" : "NoExecute",
          "tolerationSeconds" : 60
        }, {
          "key" : "node.kubernetes.io/unreachable",
          "operator" : "Exists",
          "effect" : "NoExecute",
          "tolerationSeconds" : 60
        } ],
        "upstream_nameservers" : [ ]
      }
    }
  }
}

Example Responses

Status code: 201

OK

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "90b775e0-5774-4e1d-ab3b-516332ba047a",
    "name" : "coredns",
    "alias" : "coredns",
    "creationTimestamp" : "2024-07-18T04:04:21Z",
    "updateTimestamp" : "2024-07-18T04:04:21Z"
  },
  "spec" : {
    "clusterID" : "597f2d95-44ab-11ef-9e39-0255ac100115",
    "version" : "1.28.6",
    "addonTemplateName" : "coredns",
    "addonTemplateType" : "helm",
    "addonTemplateLogo" : "",
    "addonTemplateLabels" : [ "ContainerNetwork" ],
    "description" : "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services",
    "values" : {
      "basic" : {
        "cluster_ip" : "10.247.3.10",
        "cluster_version" : "v1.28",
        "image_version" : "1.28.6",
        "platform" : "linux-amd64",
        "rbac_enabled" : true,
        "swr_addr" : "swr.cn-north-7.myhuaweicloud.com",
        "swr_user" : "autopilot-official"
      },
      "custom" : {
        "multiAZBalance" : false,
        "multiAZEnabled" : false,
        "node_match_expressions" : [ ],
        "parameterSyncStrategy" : "ensureConsistent",
        "servers" : [ {
          "plugins" : [ {
            "name" : "bind",
            "parameters" : "{$POD_IP}"
          }, {
            "configBlock" : "servfail 5s",
            "name" : "cache",
            "parameters" : 30
          }, {
            "name" : "errors"
          }, {
            "name" : "health",
            "parameters" : "{$POD_IP}:8080"
          }, {
            "name" : "ready",
            "parameters" : "{$POD_IP}:8081"
          }, {
            "configBlock" : "pods insecure\nfallthrough in-addr.arpa ip6.arpa",
            "name" : "kubernetes",
            "parameters" : "cluster.local in-addr.arpa ip6.arpa"
          }, {
            "name" : "loadbalance",
            "parameters" : "round_robin"
          }, {
            "name" : "prometheus",
            "parameters" : "{$POD_IP}:9153"
          }, {
            "configBlock" : "policy random",
            "name" : "forward",
            "parameters" : ". /etc/resolv.conf"
          }, {
            "name" : "reload"
          } ],
          "port" : 5353,
          "zones" : [ {
            "zone" : "."
          } ]
        } ],
        "stub_domains" : { },
        "tolerations" : [ {
          "effect" : "NoExecute",
          "key" : "node.kubernetes.io/not-ready",
          "operator" : "Exists",
          "tolerationSeconds" : 60
        }, {
          "effect" : "NoExecute",
          "key" : "node.kubernetes.io/unreachable",
          "operator" : "Exists",
          "tolerationSeconds" : 60
        } ],
        "upstream_nameservers" : [ ]
      },
      "flavor" : {
        "category" : [ "Autopilot" ],
        "is_default" : true,
        "name" : "autopilot-flavor1",
        "replicas" : 2,
        "resources" : [ {
          "id" : "coredns",
          "limitsCpu" : "1000m",
          "limitsMem" : "2048Mi",
          "name" : "coredns",
          "requestsCpu" : "1000m",
          "requestsMem" : "2048Mi"
        } ]
      },
      "systemAutoInject" : {
        "cluster" : {
          "clusterID" : "597f2d95-44ab-11ef-9e39-0255ac100115",
          "clusterNetworkMode" : "eni",
          "clusterVersion" : "v1.28.5-r0"
        },
        "user" : {
          "projectID" : "47eb1d64cbeb45cfa01ae20af4f4b563"
        }
      }
    }
  },
  "status" : {
    "status" : "installing",
    "Reason" : "",
    "message" : "",
    "targetVersions" : null,
    "isRollbackable" : false,
    "currentVersion" : {
      "version" : "1.28.6",
      "input" : {
        "basic" : {
          "cluster_ip" : "10.247.3.10",
          "image_version" : "1.28.6",
          "swr_addr" : "swr.cn-north-7.myhuaweicloud.com",
          "swr_user" : "autopilot-official"
        },
        "parameters" : {
          "autopilot-flavor1" : {
            "category" : [ "Autopilot" ],
            "is_default" : true,
            "name" : "autopilot-flavor1",
            "replicas" : 2,
            "resources" : [ {
              "limitsCpu" : 1,
              "limitsMem" : "2Gi",
              "name" : "coredns",
              "requestsCpu" : 1,
              "requestsMem" : "2Gi"
            } ]
          },
          "custom" : {
            "multiAZBalance" : false,
            "multiAZEnabled" : false,
            "node_match_expressions" : [ ],
            "parameterSyncStrategy" : "ensureConsistent",
            "servers" : [ {
              "plugins" : [ {
                "name" : "bind",
                "parameters" : "{$POD_IP}"
              }, {
                "configBlock" : "servfail 5s",
                "name" : "cache",
                "parameters" : 30
              }, {
                "name" : "errors"
              }, {
                "name" : "health",
                "parameters" : "{$POD_IP}:8080"
              }, {
                "name" : "ready",
                "parameters" : "{$POD_IP}:8081"
              }, {
                "configBlock" : "pods insecure\nfallthrough in-addr.arpa ip6.arpa",
                "name" : "kubernetes",
                "parameters" : "cluster.local in-addr.arpa ip6.arpa"
              }, {
                "name" : "loadbalance",
                "parameters" : "round_robin"
              }, {
                "name" : "prometheus",
                "parameters" : "{$POD_IP}:9153"
              }, {
                "configBlock" : "policy random",
                "name" : "forward",
                "parameters" : ". /etc/resolv.conf"
              }, {
                "name" : "reload"
              } ],
              "port" : 5353,
              "zones" : [ {
                "zone" : "."
              } ]
            } ],
            "stub_domains" : { },
            "tolerations" : [ {
              "effect" : "NoExecute",
              "key" : "node.kubernetes.io/not-ready",
              "operator" : "Exists",
              "tolerationSeconds" : 60
            }, {
              "effect" : "NoExecute",
              "key" : "node.kubernetes.io/unreachable",
              "operator" : "Exists",
              "tolerationSeconds" : 60
            } ],
            "upstream_nameservers" : [ ]
          },
          "flavor1" : {
            "is_default" : true,
            "name" : 2500,
            "recommend_cluster_flavor_types" : [ "small" ],
            "replicas" : 2,
            "resources" : [ {
              "limitsCpu" : "500m",
              "limitsMem" : "512Mi",
              "name" : "coredns",
              "requestsCpu" : "500m",
              "requestsMem" : "512Mi"
            } ]
          },
          "flavor2" : {
            "name" : 5000,
            "recommend_cluster_flavor_types" : [ "medium" ],
            "replicas" : 2,
            "resources" : [ {
              "limitsCpu" : "1000m",
              "limitsMem" : "1024Mi",
              "name" : "coredns",
              "requestsCpu" : "1000m",
              "requestsMem" : "1024Mi"
            } ]
          },
          "flavor3" : {
            "name" : 10000,
            "recommend_cluster_flavor_types" : [ "large" ],
            "replicas" : 2,
            "resources" : [ {
              "limitsCpu" : "2000m",
              "limitsMem" : "2048Mi",
              "name" : "coredns",
              "requestsCpu" : "2000m",
              "requestsMem" : "2048Mi"
            } ]
          },
          "flavor4" : {
            "name" : 20000,
            "recommend_cluster_flavor_types" : [ "xlarge" ],
            "replicas" : 4,
            "resources" : [ {
              "limitsCpu" : "2000m",
              "limitsMem" : "2048Mi",
              "name" : "coredns",
              "requestsCpu" : "2000m",
              "requestsMem" : "2048Mi"
            } ]
          }
        }
      },
      "stable" : true,
      "translate" : {
        "en_US" : {
          "addon" : {
            "changeLog" : "Support autopilot cluster",
            "description" : "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services"
          },
          "description" : {
            "Parameters.custom.stub_domains" : "The target nameserver may itself be a Kubernetes service. For instance, you can run your own copy of dnsmasq to export custom DNS names into the ClusterDNS namespace, a JSON map using a DNS suffix key (for example, **\"acme.local\"**) and a value consisting of a JSON array of DNS IPs.",
            "Parameters.custom.upstream_nameservers" : "If specified, then the values specified replace the nameservers taken by default from the node's **/etc/resolv.conf**. Limits: A maximum of three upstream nameservers can be specified. A JSON array of DNS IPs.",
            "Parameters.flavor1.description" : "Concurrent domain name resolution ability - External domain name: 2500 qps, Internal domain name: 10000 qps",
            "Parameters.flavor1.name" : 2500,
            "Parameters.flavor2.description" : "Concurrent domain name resolution ability - External domain name: 5000 qps, Internal domain name: 20000 qps",
            "Parameters.flavor2.name" : 5000,
            "Parameters.flavor3.description" : "Concurrent domain name resolution ability - External domain name: 10000 qps, Internal domain name: 40000 qps",
            "Parameters.flavor3.name" : 10000,
            "Parameters.flavor4.description" : "Concurrent domain name resolution ability - External domain name: 20000 qps, Internal domain name: 80000 qps",
            "Parameters.flavor4.name" : 20000
          },
          "key" : {
            "Parameters.custom.stub_domains" : "stub domain",
            "Parameters.custom.upstream_nameservers" : "upstream nameservers"
          }
        },
        "fr_FR" : {
          "addon" : {
            "changeLog" : "les spécifications du plugin peuvent être associées aux spécifications du cluster. le fuseau horaire du plug-in est le même que celui du noeud",
            "description" : "Un serveur DNS qui enchaîne les plug-ins et fournit des services DNS Kubernetes."
          },
          "description" : {
            "Parameters.custom.stub_domains" : "Le serveur de noms cible peut lui-même être un service Kubernetes. Par exemple, vous pouvez exécuter votre propre copie de dnsmasq pour exporter des noms DNS personnalisés dans l'espace de noms ClusterDNS, une carte JSON à l'aide d'une clé de suffixe DNS (par exemple, «acme.local») et une valeur constituée d'un tableau JSON d'adresses IP DNS.",
            "Parameters.custom.upstream_nameservers" : "Si spécifié, les valeurs spécifiées remplacent les serveurs de noms pris par défaut dans le fichier /etc/resolv.conf du nœud. Limites: un maximum de trois serveurs de noms en amont peuvent être spécifiés, un tableau JSON d'adresses IP DNS.",
            "Parameters.flavor1.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 2500 qps, Nom de domaine interne: 10000 qp",
            "Parameters.flavor1.name" : 2500,
            "Parameters.flavor2.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 5000 qps, Nom de domaine interne: 20000 qp",
            "Parameters.flavor2.name" : 5000,
            "Parameters.flavor3.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 10000 qps, Nom de domaine interne: 40000 qp",
            "Parameters.flavor3.name" : 10000,
            "Parameters.flavor4.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 20000 qps, Nom de domaine interne: 80000 qp",
            "Parameters.flavor4.name" : 20000
          },
          "key" : {
            "Parameters.custom.stub_domains" : "domaine stub",
            "Parameters.custom.upstream_nameservers" : "serveurs de noms en amont"
          }
        },
        "zh_CN" : {
          "addon" : {
            "changeLog" : "Autopilot clusters are supported.",
            "description" : "CoreDNS is a DNS server that chains plug-ins and offers DNS resolution for Kubernetes clusters."
          },
          "description" : {
            "Parameters.custom.stub_domains" : "A domain name server for a custom domain name in key-value pair. The key is a suffix of DNS domain name, and the value is one or more DNS IP addresses, for example, **acme.local -- 1.2.3.4,6.7.8.9**.",
            "Parameters.custom.upstream_nameservers" : "Resolves all domain names except intra-cluster service domain names and custom domain names. The value can be one or more DNS IP addresses, for example, **\"8.8.8.8\",\"8.8.4.4\"**.",
            "Parameters.flavor1.description" : "Concurrent domain name resolution capability - external domain name: 2500 qps, internal domain name: 10000 qps",
            "Parameters.flavor1.name" : 2500,
            "Parameters.flavor2.description" : "Concurrent domain name resolution capability - external domain name: 5000 qps, internal domain name: 20000 qps",
            "Parameters.flavor2.name" : 5000,
            "Parameters.flavor3.description" : "Concurrent domain name resolution capability - external domain name: 10000 qps, internal domain name: 40000 qps",
            "Parameters.flavor3.name" : 10000,
            "Parameters.flavor4.description" : "Concurrent domain name resolution capability - external domain name: 20000 qps, internal domain name: 80000 qps",
            "Parameters.flavor4.name" : 20000
          },
          "key" : {
            "Parameters.custom.stub_domains" : "Stub domain",
            "Parameters.custom.upstream_nameservers" : "Upstream DNS server"
          }
        }
      },
      "supportVersions" : null,
      "creationTimestamp" : "2024-02-19T11:33:46Z",
      "updateTimestamp" : "2024-02-21T01:24:05Z"
    }
  }
}

SDK Sample Code

The SDK sample code is as follows.

Status Codes

Error Codes

See Error Codes.