Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating documentation to reflect the latest status of extension resources #15981

Merged
merged 1 commit into from
Oct 23, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/kube-apiserver/app/server.go
Expand Up @@ -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/<version> 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/<groupVersion> key can be used to turn on/off specific api versions. apis/<groupVersion>/<resource> 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.
Expand Down
5 changes: 3 additions & 2 deletions docs/admin/daemons.md
Expand Up @@ -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.
Expand Down
9 changes: 5 additions & 4 deletions docs/api.md
Expand Up @@ -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

Expand Down
3 changes: 1 addition & 2 deletions docs/user-guide/jobs.md
Expand Up @@ -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
Expand Down