Skip to content

Commit

Permalink
split setup-api-aggregator.md into two docs and address feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
chenopis committed Jun 25, 2017
1 parent b1142e1 commit e726565
Show file tree
Hide file tree
Showing 5 changed files with 113 additions and 71 deletions.
3 changes: 2 additions & 1 deletion _data/tasks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ toc:
- docs/tasks/access-kubernetes-api/http-proxy-access-api.md
- docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions.md
- docs/tasks/access-kubernetes-api/extend-api-third-party-resource.md
- docs/tasks/access-kubernetes-api/setup-api-aggregator.md
- docs/tasks/access-kubernetes-api/configure-aggregation-layer.md
- docs/tasks/access-kubernetes-api/setup-extension-api-server.md

- title: TLS
section:
Expand Down
9 changes: 6 additions & 3 deletions docs/concepts/api-extension/apiserver-aggregation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Extending the Kubernetes API with Aggregator
title: Extending the Kubernetes API with the aggregation layer
assignees:
- lavalamp
- cheftako
- chenopis
---

Expand All @@ -24,8 +26,9 @@ In 1.7 the aggregation layer runs in-process with the kube-apiserver. Until an e

{% capture whatsnext %}

* To get the aggregator working in your environment, see [Setup the API aggregator](/docs/tasks/access-kubernetes-api/setup-api-aggregator/).
* Learn how to [Extend the Kubernetes API Using Custom Resource Definitions](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/).
* To get the aggregator working in your environment, [configure the aggregation layer](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/).
* Then, [setup an extension api-server](/docs/tasks/access-kubernetes-api/setup-extension-api-server/) to work with the aggregation layer.
* Also, learn how to [extend the Kubernetes API using Custom Resource Definitions](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/).

{% endcapture %}

Expand Down
52 changes: 52 additions & 0 deletions docs/tasks/access-kubernetes-api/configure-aggregation-layer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Configure the aggregation layer
assignees:
- lavalamp
- cheftako
- chenopis
---

{% capture overview %}

Configuring the aggregation layer allows the Kubernetes apiserver to be extended with additional APIs, which are not part of the core Kubernetes APIs.

{% endcapture %}

{% capture prerequisites %}

* You need to have a Kubernetes cluster running.

**Note:** There are a few setup requirements for getting the aggregation layer working in your environment to support mutual TLS auth between the proxy and extension apiservers. Kubernetes and the kube-apiserver have multiple CAs, so make sure that the proxy is signed by the aggregation layer CA and not by something else, like the master CA.

{% endcapture %}

{% capture steps %}

## Enable apiserver flags

Enable the aggregation layer via the following apiserver flags. They may have already been taken care of by your provider.

--requestheader-client-ca-file=<path to aggregator CA cert>
--requestheader-allowed-names=aggregator
--requestheader-extra-headers-prefix=X-Remote-Extra-
--requestheader-group-headers=X-Remote-Group
--requestheader-username-headers=X-Remote-User
--proxy-client-cert-file=<path to aggregator proxy cert>
--proxy-client-key-file=<path to aggregator proxy key>

The [Kubernetes Architectural Roadmap](https://docs.google.com/a/google.com/document/d/1XkjVm4bOeiVkj-Xt1LgoGiqWsBfNozJ51dyI-ljzt1o/edit?usp=sharing) recommends not running kube-proxy on the master. If you follow this recommendation, then you must make sure that the system is enabled with the following apiserver flag. Again, this may have already been taken care of by your provider.

--enable-aggregator-routing=true

{% endcapture %}

{% capture whatsnext %}

* [Setup an extension api-server](/docs/tasks/access-kubernetes-api/setup-extension-api-server/) to work with the aggregation layer.
* For a high level overview, see [Extending the Kubernetes API with Aggregator](/docs/concepts/api-extension/apiserver-aggregation/).
* Learn how to [Extend the Kubernetes API Using Custom Resource Definitions](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/).

{% endcapture %}

{% include templates/task.md %}

67 changes: 0 additions & 67 deletions docs/tasks/access-kubernetes-api/setup-api-aggregator.md

This file was deleted.

53 changes: 53 additions & 0 deletions docs/tasks/access-kubernetes-api/setup-extension-api-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Setup an extension API server
assignees:
- lavalamp
- cheftako
- chenopis
---

{% capture overview %}

Setting up an extension API server to work the aggregation layer allows the Kubernetes apiserver to be extended with additional APIs, which are not part of the core Kubernetes APIs.

{% endcapture %}

{% capture prerequisites %}

* You need to have a Kubernetes cluster running.
* You must [configure the aggregation layer](/docs/tasks/configure-aggregation-layer) and enable the apiserver flags.

{% endcapture %}

{% capture steps %}

## Setup an extension api-server to work with the aggregation layer

If you use an existing 3rd party solution, such as [apiserver-builder](https://github.com/Kubernetes-incubator/apiserver-builder/blob/master/README.md), it should generate a skeleton and perform all of the following steps. Alternatively, you can also look at the [sample-apiserver](https://github.com/kubernetes/sample-apiserver/blob/master/README.md) under Kubernetes for ways the following can be done.

1. Make sure the APIService API is enabled (check --runtime-config); it is on by default, so it should be on unless it’s been deliberately turned off in your cluster.
1. You may need to make an RBAC rule allowing you to add APIService objects, or get your cluster administrator to make one. (Since API extensions affect the entire cluster, it is not recommended to do testing/development/debug of an API extension in a live cluster.)
1. Create the Kubernetes namespace you want to run your extension api-service in.
1. Create/get a CA cert to be used to sign the server cert the extension api-server uses for HTTPS.
1. Create a server cert/key for the api-server to use for HTTPS. This cert should be signed by the above CA. It should also have a CN of the Kube DNS name. This is derived from the Kubernetes service and be of the form <service name>.<service name namespace>.svc
1. Create a Kubernetes secret with the server cert/key in your namespace.
1. Create a Kubernetes deployment for the extension api-server and make sure you are loading the secret as a volume. It should contain a reference to a working image of your extension api-server. The deployment should also be in your namespace.
1. Make sure that your extension-apiserver loads those certs from that volume and that they are used in the HTTPS handshake.
1. Create a Kubernetes service account in your namespace.
1. Create a Kubernetes cluster role for the operations you want to allow on your resources.
1. Create a Kubernetes cluster role binding from the default service account in your namespace to the cluster role you just created.
1. Create a Kubernetes apiservice. The CA cert above should be base 64 encoded, stripped of new lines and used as the spec.caBundle in the apiservce. This should not be namespaced.
1. Use kubectl to get your resource. It should return "No resources found." Which means that everything worked but you currently have no objects of that resource type created yet.

{% endcapture %}

{% capture whatsnext %}

* If you haven't already, [configure the aggregation layer](/docs/tasks/configure-aggregation-layer) and enable the apiserver flags.
* For a high level overview, see [Extending the Kubernetes API with Aggregator](/docs/concepts/api-extension/apiserver-aggregation/).
* Learn how to [Extend the Kubernetes API Using Custom Resource Definitions](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/).

{% endcapture %}

{% include templates/task.md %}

0 comments on commit e726565

Please sign in to comment.