From 72914fd81b52e2fd6ad2a2396ba96bca04875270 Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Tue, 20 Oct 2015 15:36:29 -0700 Subject: [PATCH] Updating documentation to reflect the latest status of extension resources --- cmd/kube-apiserver/app/server.go | 2 +- docs/admin/daemons.md | 5 +++-- docs/api.md | 9 +++++---- docs/user-guide/jobs.md | 3 +-- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/cmd/kube-apiserver/app/server.go b/cmd/kube-apiserver/app/server.go index d260b4bca66..21b866d2434 100644 --- a/cmd/kube-apiserver/app/server.go +++ b/cmd/kube-apiserver/app/server.go @@ -225,7 +225,7 @@ func (s *APIServer) AddFlags(fs *pflag.FlagSet) { fs.Var(&s.ServiceNodePortRange, "service-node-ports", "Deprecated: see --service-node-port-range instead.") fs.MarkDeprecated("service-node-ports", "see --service-node-port-range instead.") fs.StringVar(&s.MasterServiceNamespace, "master-service-namespace", s.MasterServiceNamespace, "The namespace from which the kubernetes master services should be injected into pods") - fs.Var(&s.RuntimeConfig, "runtime-config", "A set of key=value pairs that describe runtime configuration that may be passed to the apiserver. api/ key can be used to turn on/off specific api versions. api/all and api/legacy are special keys to control all and legacy api versions respectively.") + fs.Var(&s.RuntimeConfig, "runtime-config", "A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.") fs.StringVar(&s.ClusterName, "cluster-name", s.ClusterName, "The instance prefix for the cluster") fs.BoolVar(&s.EnableProfiling, "profiling", true, "Enable profiling via web interface host:port/debug/pprof/") // TODO: enable cache in integration tests. diff --git a/docs/admin/daemons.md b/docs/admin/daemons.md index 2877d65811c..3d1edace7ff 100644 --- a/docs/admin/daemons.md +++ b/docs/admin/daemons.md @@ -209,8 +209,9 @@ all or certain hosts, and when it needs to start before other pods. ## Caveats -DaemonSet objects are in the [`extensions` API Group](../api.md#api-groups). This API group may or -may not be enabled on your cluster. +DaemonSet objects are in the [`extensions` API Group](../api.md#api-groups). +DaemonSet is not enabled by default. Enable it by setting +`--runtime-config=extensions/v1beta1/daemonset` on the api server. DaemonSet objects effectively have [API version `v1alpha1`](../api.md#api-versioning). Alpha objects may change or even be discontinued in future software releases. diff --git a/docs/api.md b/docs/api.md index 2a0586dbf4e..53257521054 100644 --- a/docs/api.md +++ b/docs/api.md @@ -107,11 +107,12 @@ In the future we expect that there will be more API groups, all at REST path `/a using `apiVersion: $API_GROUP/$VERSION`. We expect that there will be a way for (third parties to create their own API groups](design/extending-api.md), and to avoid naming collisions. -## Enabling the extensions group +## Enabling resources in the extensions group -Enable `extensions/v1beta1` objects by adding the following flags to your API server: - - - `--runtime-config=extensions/v1beta1=true` +Jobs, Ingress and HorizontalPodAutoscalers are enabled by default. +Other extensions resources can be enabled by setting runtime-config on +apiserver. runtime-config accepts comma separated values. For ex: to enable deployments and disable jobs, set +`--runtime-config=extensions/v1beta1/deployments=true,extensions/v1beta1/jobs=false` ## v1beta1, v1beta2, and v1beta3 are deprecated; please move to v1 ASAP diff --git a/docs/user-guide/jobs.md b/docs/user-guide/jobs.md index 6896e331244..e0afa9b2a26 100644 --- a/docs/user-guide/jobs.md +++ b/docs/user-guide/jobs.md @@ -241,8 +241,7 @@ value is `Always`.) ## Caveats -Job objects are in the [`extensions` API Group](../api.md#api-groups). This API group may or -may not be enabled on your cluster. +Job objects are in the [`extensions` API Group](../api.md#api-groups). Job objects have [API version `v1beta1`](../api.md#api-versioning). Beta objects may undergo changes to their schema and/or semantics in future software releases, but