Skip to content

Commit

Permalink
Initial checkin of v1.1 -- does not build
Browse files Browse the repository at this point in the history
  • Loading branch information
John Mulhausen committed Feb 11, 2016
1 parent d1da8c3 commit a0fb30a
Show file tree
Hide file tree
Showing 420 changed files with 49,449 additions and 158 deletions.
20 changes: 0 additions & 20 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,4 @@ defaults:
values:
version: "v1.1"
versionfilesafe: "v1_1"
-
scope:
path: "v1.1/reference"
values:
section: "reference"
-
scope:
path: "v1.1/guides"
values:
section: "guides"
-
scope:
path: "v1.1/support"
values:
section: "support"
-
scope:
path: "v1.1/samples"
values:
section: "samples"
permalink: pretty
Binary file modified v1.1/.DS_Store
Binary file not shown.
19 changes: 19 additions & 0 deletions v1.1/api-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
layout: docwithnav
title: "Kubernetes API Reference"
---

## {{ page.title }} ##

Use these reference documents to learn how to interact with Kubernetes through the REST API.

You can also view details about the *Extensions API*. For more about extensions, see [API versioning](docs/api.html).

<p>Table of Contents:</p>
<ul id="toclist"></ul>

<script>
$(function() {
$('#toclist').load( location.pathname + " #gentocapiref li" );
});
</script>
17 changes: 17 additions & 0 deletions v1.1/app-admin-detailed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: docwithnav
title: "Application Administration: Detailed Walkthrough"
---

## {{ page.title }} ##

The detailed walkthrough covers all the in-depth details and tasks for administering your applications in Kubernetes.

<p>Table of Contents:</p>
<ul id="toclist"></ul>

<script>
$(function() {
$('#toclist').load( location.pathname + " #gentocappadmin li" );
});
</script>
17 changes: 17 additions & 0 deletions v1.1/basicstutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: docwithnav
title: "Quick Walkthrough: Kubernetes Basics"
---

## {{ page.title }} ##

Use this quick walkthrough of Kubernetes to learn about the basic application administration tasks.

<p>Table of Contents:</p>
<ul id="toclist"></ul>

<script>
$(function() {
$('#toclist').load( location.pathname + " #gentocbasictut li" );
});
</script>
17 changes: 17 additions & 0 deletions v1.1/deploy-clusters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: docwithnav
title: "Examples: Deploying Clusters"
---

## {{ page.title }} ##

Use the following examples to learn how to deploy your application into a Kubernetes cluster.

<p>Table of Contents:</p>
<ul id="toclist"></ul>

<script>
$(function() {
$('#toclist').load( location.pathname + " #gentocdplyclst li" );
});
</script>
49 changes: 49 additions & 0 deletions v1.1/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: docwithnav
title: "Kubernetes Documentation: releases.k8s.io/release-1.1"
---
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->


<!-- END MUNGE: UNVERSIONED_WARNING -->

# Kubernetes Documentation: releases.k8s.io/release-1.1

* The [User's guide](user-guide/README.html) is for anyone who wants to run programs and
services on an existing Kubernetes cluster.

* The [Cluster Admin's guide](admin/README.html) is for anyone setting up
a Kubernetes cluster or administering it.

* The [Developer guide](devel/README.html) is for anyone wanting to write
programs that access the Kubernetes API, write plugins or extensions, or
modify the core code of Kubernetes.

* The [Kubectl Command Line Interface](user-guide/kubectl/kubectl.html) is a detailed reference on
the `kubectl` CLI.

* The [API object documentation](http://kubernetes.io/third_party/swagger-ui/)
is a detailed description of all fields found in core API objects.

* An overview of the [Design of Kubernetes](design/)

* There are example files and walkthroughs in the [examples](../examples/)
folder.

* If something went wrong, see the [troubleshooting](troubleshooting.html) document for how to debug.
You should also check the [known issues](user-guide/known-issues.html) for the release you're using.

* To report a security issue, see [Reporting a Security Issue](reporting-security-issues.html).




<!-- BEGIN MUNGE: IS_VERSIONED -->
<!-- TAG IS_VERSIONED -->
<!-- END MUNGE: IS_VERSIONED -->


<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/README.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->

58 changes: 58 additions & 0 deletions v1.1/docs/admin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: docwithnav
title: "Kubernetes Cluster Admin Guide"
---
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->


<!-- END MUNGE: UNVERSIONED_WARNING -->

# Kubernetes Cluster Admin Guide

The cluster admin guide is for anyone creating or administering a Kubernetes cluster.
It assumes some familiarity with concepts in the [User Guide](../user-guide/README.html).

## Admin Guide Table of Contents

[Introduction](introduction.html)

1. [Components of a cluster](cluster-components.html)
1. [Cluster Management](cluster-management.html)
1. Administrating Master Components
1. [The kube-apiserver binary](kube-apiserver.html)
1. [Authorization](authorization.html)
1. [Authentication](authentication.html)
1. [Accessing the api](accessing-the-api.html)
1. [Admission Controllers](admission-controllers.html)
1. [Administrating Service Accounts](service-accounts-admin.html)
1. [Resource Quotas](resource-quota.html)
1. [The kube-scheduler binary](kube-scheduler.html)
1. [The kube-controller-manager binary](kube-controller-manager.html)
1. [Administrating Kubernetes Nodes](node.html)
1. [The kubelet binary](kubelet.html)
1. [Garbage Collection](garbage-collection.html)
1. [The kube-proxy binary](kube-proxy.html)
1. Administrating Addons
1. [DNS](dns.html)
1. [Networking](networking.html)
1. [OVS Networking](ovs-networking.html)
1. Example Configurations
1. [Multiple Clusters](multi-cluster.html)
1. [High Availability Clusters](high-availability.html)
1. [Large Clusters](cluster-large.html)
1. [Getting started from scratch](../getting-started-guides/scratch.html)
1. [Kubernetes's use of salt](salt.html)
1. [Troubleshooting](cluster-troubleshooting.html)




<!-- BEGIN MUNGE: IS_VERSIONED -->
<!-- TAG IS_VERSIONED -->
<!-- END MUNGE: IS_VERSIONED -->


<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/README.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->

91 changes: 91 additions & 0 deletions v1.1/docs/admin/accessing-the-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
layout: docwithnav
title: "Configuring APIserver ports"
---
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->


<!-- END MUNGE: UNVERSIONED_WARNING -->

# Configuring APIserver ports

This document describes what ports the Kubernetes apiserver
may serve on and how to reach them. The audience is
cluster administrators who want to customize their cluster
or understand the details.

Most questions about accessing the cluster are covered
in [Accessing the cluster](../user-guide/accessing-the-cluster.html).


## Ports and IPs Served On

The Kubernetes API is served by the Kubernetes apiserver process. Typically,
there is one of these running on a single kubernetes-master node.

By default the Kubernetes APIserver serves HTTP on 2 ports:
1. Localhost Port
- serves HTTP
- default is port 8080, change with `--insecure-port` flag.
- defaults IP is localhost, change with `--insecure-bind-address` flag.
- no authentication or authorization checks in HTTP
- protected by need to have host access
2. Secure Port
- default is port 6443, change with `--secure-port` flag.
- default IP is first non-localhost network interface, change with `--bind-address` flag.
- serves HTTPS. Set cert with `--tls-cert-file` and key with `--tls-private-key-file` flag.
- uses token-file or client-certificate based [authentication](authentication.html).
- uses policy-based [authorization](authorization.html).
3. Removed: ReadOnly Port
- For security reasons, this had to be removed. Use the [service account](../user-guide/service-accounts.html) feature instead.

## Proxies and Firewall rules

Additionally, in some configurations there is a proxy (nginx) running
on the same machine as the apiserver process. The proxy serves HTTPS protected
by Basic Auth on port 443, and proxies to the apiserver on localhost:8080. In
these configurations the secure port is typically set to 6443.

A firewall rule is typically configured to allow external HTTPS access to port 443.

The above are defaults and reflect how Kubernetes is deployed to Google Compute Engine using
kube-up.sh. Other cloud providers may vary.

## Use Cases vs IP:Ports

There are three differently configured serving ports because there are a
variety of uses cases:
1. Clients outside of a Kubernetes cluster, such as human running `kubectl`
on desktop machine. Currently, accesses the Localhost Port via a proxy (nginx)
running on the `kubernetes-master` machine. The proxy can use cert-based authentication
or token-based authentication.
2. Processes running in Containers on Kubernetes that need to read from
the apiserver. Currently, these can use a [service account](../user-guide/service-accounts.html).
3. Scheduler and Controller-manager processes, which need to do read-write
API operations. Currently, these have to run on the same host as the
apiserver and use the Localhost Port. In the future, these will be
switched to using service accounts to avoid the need to be co-located.
4. Kubelets, which need to do read-write API operations and are necessarily
on different machines than the apiserver. Kubelet uses the Secure Port
to get their pods, to find the services that a pod can see, and to
write events. Credentials are distributed to kubelets at cluster
setup time. Kubelet and kube-proxy can use cert-based authentication or token-based
authentication.

## Expected changes

- Policy will limit the actions kubelets can do via the authed port.
- Scheduler and Controller-manager will use the Secure Port too. They
will then be able to run on different machines than the apiserver.



<!-- BEGIN MUNGE: IS_VERSIONED -->
<!-- TAG IS_VERSIONED -->
<!-- END MUNGE: IS_VERSIONED -->


<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/accessing-the-api.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->

Loading

0 comments on commit a0fb30a

Please sign in to comment.