From af4aec69769d583e753371e5bd231670ce4d85a2 Mon Sep 17 00:00:00 2001 From: Eric Tune Date: Mon, 26 Feb 2018 12:24:36 -0800 Subject: [PATCH] Update README.md of sample-apiserver. Mention CRDs as option. Link to CRD vs Aggr. docs. Mention apiserver-builder as alternative. --- staging/src/k8s.io/sample-apiserver/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/staging/src/k8s.io/sample-apiserver/README.md b/staging/src/k8s.io/sample-apiserver/README.md index 5a9eb86031a..c5cbc41175a 100644 --- a/staging/src/k8s.io/sample-apiserver/README.md +++ b/staging/src/k8s.io/sample-apiserver/README.md @@ -5,7 +5,13 @@ Demonstration of how to use the k8s.io/apiserver library to build a functional A ## Purpose -This is intended as an example of how to build a kube-like API server with a single type. +You may use this code if you want to build an Extension API Server to use with API Aggregation, or to build a stand-alone Kubernetes-style API server. + +However, consider two other options: + * **CRDs**: if you just want to add a resource to your kubernetes cluster, then consider using Custom Resource Definition a.k.a CRDs. They require less coding and rebasing. Read about the differences between Custom Resource Definitions vs Extension API Servers [here](https://kubernetes.io/docs/concepts/api-extension/custom-resources). + * **Apiserver-builder**: If you want to build an Extension API server, consider using [apiserver-builder](https://github.com/kubernetes-incubator/apiserver-builder) instead of this repo. The Apiserver-builder is a complete framework for generating the apiserver, client libraries, and the installation program. + +If you do decide to use this repository, then the recommended pattern is to fork this repository, modify it to add your types, and then periodically rebase your changes on top of this repo, to pick up improvements and bug fixes to the apiserver. ## Compatibility