KubeSphere API

In KubeSphere v3.0, we move the functionalities of ks-apigateway, ks-account into ks-apiserver to make the architecture more compact and straight forward. In order to use KubeSphere API, you need to expose ks-apiserver to your client.

Step 1: Expose KubeSphere API service

If you are going to access KubeSphere inside the cluster, you can skip the following section and just use the KubeSphere API server endpoint http://ks-apiserver.kubesphere-system.svc.

On the other hand, you need to expose the KubeSphere API server endpoint to the outside of the cluster first.

There are many ways to expose a Kubernetes service. For simplicity, we use NodePort in our case. Change service ks-apiserver type to NodePort by using the following command.

  1. $ kubectl -n kubesphere-system patch service ks-apiserver -p '{"spec":{"type":"NodePort"}}'
  2. $ kubectl -n kubesphere-system get svc
  3. NAME            TYPE           CLUSTER-IP      EXTERNAL-IP      PORT(S)              AGE
  4. etcd            ClusterIP      10.233.34.220   <none>           2379/TCP             44d
  5. ks-apiserver    NodePort       10.233.15.31    <none>           80:31407/TCP         49d
  6. ks-console      NodePort       10.233.3.45     <none>           80:30880/TCP         49d

Now, you can access ks-apiserver outside the cluster through URL like http://[node ip]:31407, where [node ip] means IP of any node in your cluster.

Step 2: Generate a token

You need to identify yourself before making any call to the API server. Let’s take a user jeff with password P#$$w0rd as an example. He needs to issue a request to generate a token like the following:

  1. curl -X POST -H 'Content-Type: application/x-www-form-urlencoded' \
  2.  'http://[node ip]:31407/oauth/token' \
  3.   --data-urlencode 'grant_type=password' \
  4.   --data-urlencode 'username=admin' \
  5.   --data-urlencode 'password=P#$$w0rd'

备注

Please substitue [node ip] with the real ip address.

If the identity is correct, the server will response something like the following. access_token is the token to access the KubeSphere API Server.

  1. {
  2.  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwidWlkIjoiYTlhNjJmOTEtYWQ2Yi00MjRlLWIxNWEtZTFkOTcyNmUzNDFhIiwidG9rZW5fdHlwZSI6ImFjY2Vzc190b2tlbiIsImV4cCI6MTYwMDg1MjM5OCwiaWF0IjoxNjAwODQ1MTk4LCJpc3MiOiJrdWJlc3BoZXJlIiwibmJmIjoxNjAwODQ1MTk4fQ.Hcyf-CPMeq8XyQQLz5PO-oE1Rp1QVkOeV_5J2oX1hvU",
  3.  "token_type": "Bearer",
  4.  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwidWlkIjoiYTlhNjJmOTEtYWQ2Yi00MjRlLWIxNWEtZTFkOTcyNmUzNDFhIiwidG9rZW5fdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJleHAiOjE2MDA4NTk1OTgsImlhdCI6MTYwMDg0NTE5OCwiaXNzIjoia3ViZXNwaGVyZSIsIm5iZiI6MTYwMDg0NTE5OH0.PerssCLVXJD7BuCF3Ow8QUNYLQxjwqC8m9iOkRRD6Tc",
  5.  "expires_in": 7200
  6. }

Step 3: Make the call

Now you got everything you need to access KubeSphere API server. Make the call using the access token acquired above as the following to get node list:

  1. $ curl -X GET -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwidWlkIjoiYTlhNjJmOTEtYWQ2Yi00MjRlLWIxNWEtZTFkOTcyNmUzNDFhIiwidG9rZW5fdHlwZSI6ImFjY2Vzc190b2tlbiIsImV4cCI6MTYwMDg1MjM5OCwiaWF0IjoxNjAwODQ1MTk4LCJpc3MiOiJrdWJlc3BoZXJlIiwibmJmIjoxNjAwODQ1MTk4fQ.Hcyf-CPMeq8XyQQLz5PO-oE1Rp1QVkOeV_5J2oX1hvU" \
  2.   -H 'Content-Type: application/json' \
  3.   'http://[node ip]:31407/kapis/resources.kubesphere.io/v1alpha3/nodes'
  5. {
  6.  "items": [
  7.   {
  8.    "metadata": {
  9.     "name": "node3",
  10.     "selfLink": "/api/v1/nodes/node3",
  11.     "uid": "dd8c01f3-76e8-4695-9e54-45be90d9ec53",
  12.     "resourceVersion": "84170589",
  13.     "creationTimestamp": "2020-06-18T07:36:41Z",
  14.     "labels": {
  15.      "a": "a",
  16.      "beta.kubernetes.io/arch": "amd64",
  17.      "beta.kubernetes.io/os": "linux",
  18.      "gitpod.io/theia.v0.4.0": "available",
  19.      "gitpod.io/ws-sync": "available",
  20.      "kubernetes.io/arch": "amd64",
  21.      "kubernetes.io/hostname": "node3",
  22.      "kubernetes.io/os": "linux",
  23.      "kubernetes.io/role": "new",
  24.      "node-role.kubernetes.io/worker": "",
  25.      "topology.disk.csi.qingcloud.com/instance-type": "Standard",
  26.      "topology.disk.csi.qingcloud.com/zone": "ap2a"
  27.     },
  28.     "annotations": {
  29.      "csi.volume.kubernetes.io/nodeid": "{\"disk.csi.qingcloud.com\":\"i-icjxhi1e\"}",
  30.      "kubeadm.alpha.kubernetes.io/cri-socket": "/var/run/dockershim.sock",
  31.      "node.alpha.kubernetes.io/ttl": "0",
  32.      ....

备注

Please substitue [node ip] with the real ip address.

API Reference

KubeSpehre API swagger json can be found in repo https://github.com/kubesphere/kubesphere/tree/release-3.0/api

  • KubeSphere specified API swagger json. It contains all the APIs that are only applied to KubeSphere.
  • KubeSphere specified CRD swagger json. It contains all the generated CRDs API documentation. It is same with Kubernetes api objects.