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.

Sign up for GitHub

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

Jump to bottom

Update README.md to reflect OKD rebranding #20533

Merged
merged 1 commit into from
Aug 3, 2018
Merged

Update README.md to reflect OKD rebranding #20533

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 26 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
OpenShift Application Platform
==============================
OKD: The Origin Community Distribution of Kubernetes
=======================================================

[![Go Report Card](https://goreportcard.com/badge/github.com/openshift/origin)](https://goreportcard.com/report/github.com/openshift/origin)
[![GoDoc](https://godoc.org/github.com/openshift/origin?status.png)](https://godoc.org/github.com/openshift/origin)
Expand All @@ -8,7 +8,7 @@ OpenShift Application Platform
[![Join the chat at freenode:openshift-dev](https://img.shields.io/badge/irc-freenode%3A%20%23openshift--dev-blue.svg)](http://webchat.freenode.net/?channels=%23openshift-dev)
[![Licensed under Apache License version 2.0](https://img.shields.io/github/license/openshift/origin.svg?maxAge=2592000)](https://www.apache.org/licenses/LICENSE-2.0)

***OpenShift Origin*** is a distribution of [Kubernetes](https://kubernetes.io) optimized for continuous application development and multi-tenant deployment. OpenShift adds developer and operations-centric tools on top of Kubernetes to enable rapid application development, easy deployment and scaling, and long-term lifecycle maintenance for small and large teams.
***OKD*** is the Origin community distribution of [Kubernetes](https://kubernetes.io) optimized for continuous application development and multi-tenant deployment. OKD adds developer and operations-centric tools on top of Kubernetes to enable rapid application development, easy deployment and scaling, and long-term lifecycle maintenance for small and large teams. ***OKD*** is also referred to as ***Origin*** in github and in the documentation.

[![Watch the full asciicast](docs/openshift-intro.gif)](https://asciinema.org/a/49402)

Expand Down Expand Up @@ -47,32 +47,32 @@ If you have downloaded the client tools from the [releases page](https://github.
* For a full cluster installation using [Ansible](https://github.com/openshift/openshift-ansible), follow the [Advanced Installation guide](https://docs.openshift.org/latest/install_config/install/advanced_install.html)
* To build and run from source, see [CONTRIBUTING.adoc](CONTRIBUTING.adoc)

The latest OpenShift Origin images are published to the Docker Hub under the `openshift` account at https://hub.docker.com/u/openshift/. We use a rolling tag system as of v3.9, where the `:latest` tag always points to the most recent alpha release on `master`, the `v3.X` tag points to the most recent build for that release (pre-release and post-release), and `v3.X.Y` is a stable tag for patches to a release.
The latest OKD Origin images are published to the Docker Hub under the `openshift` account at https://hub.docker.com/u/openshift/. We use a rolling tag system as of v3.9, where the `:latest` tag always points to the most recent alpha release on `master`, the `v3.X` tag points to the most recent build for that release (pre-release and post-release), and `v3.X.Y` is a stable tag for patches to a release.

### Concepts

OpenShift builds a developer-centric workflow around Docker containers and Kubernetes runtime concepts. An **Image Stream** lets you easily tag, import, and publish Docker images from the integrated registry. A **Build Config** allows you to launch Docker builds, build directly from source code, or trigger Jenkins Pipeline jobs whenever an image stream tag is updated. A **Deployment Config** allows you to use custom deployment logic to rollout your application, and Kubernetes workflow objects like **DaemonSets**, **Deployments**, or **StatefulSets** are upgraded to automatically trigger when new images are available. **Routes** make it trivial to expose your Kubernetes services via a public DNS name. As an administrator, you can enable your developers to request new **Projects** which come with predefined roles, quotas, and security controls to fairly divide access.
OKD builds a developer-centric workflow around Docker containers and Kubernetes runtime concepts. An **Image Stream** lets you easily tag, import, and publish Docker images from the integrated registry. A **Build Config** allows you to launch Docker builds, build directly from source code, or trigger Jenkins Pipeline jobs whenever an image stream tag is updated. A **Deployment Config** allows you to use custom deployment logic to rollout your application, and Kubernetes workflow objects like **DaemonSets**, **Deployments**, or **StatefulSets** are upgraded to automatically trigger when new images are available. **Routes** make it trivial to expose your Kubernetes services via a public DNS name. As an administrator, you can enable your developers to request new **Projects** which come with predefined roles, quotas, and security controls to fairly divide access.

For more on the underlying concepts of OpenShift, please see the [documentation site](https://docs.openshift.org/latest/welcome/index.html).
For more on the underlying concepts of OKD, please see the [documentation site](https://docs.openshift.org/latest/welcome/index.html).

### OpenShift API
### OKD API

The OpenShift API is located on each server at `https://<host>:8443/apis`. OpenShift adds its own API groups alongside the Kubernetes APIs. For more, [see the API documentation](https://docs.openshift.org/latest/rest_api).
The OKD API is located on each server at `https://<host>:8443/apis`. OKD adds its own API groups alongside the Kubernetes APIs. For more, [see the API documentation](https://docs.openshift.org/latest/rest_api).

### Kubernetes

OpenShift extends Kubernetes with security and other developer centric concepts. Each OpenShift Origin release ships slightly after the Kubernetes release has stabilized. Version numbers are aligned - OpenShift v3.9 is Kubernetes v1.9.
OKD extends Kubernetes with security and other developer centric concepts. Each OKD release ships slightly after the Kubernetes release has stabilized. Version numbers are aligned - OKD v3.9 is Kubernetes v1.9.

If you're looking for more information about using Kubernetes or the lower level concepts that Origin depends on, see the following:
If you're looking for more information about using Kubernetes or the lower level concepts that OKD depends on, see the following:

* [Kubernetes Getting Started](https://kubernetes.io/docs/tutorials/kubernetes-basics/)
* [Kubernetes Documentation](https://kubernetes.io/docs/)
* [Kubernetes API](https://docs.openshift.org/latest/rest_api)


### What can I run on OpenShift?
### What can I run on OKD?

OpenShift is designed to run any existing Docker images. Additionally, you can define builds that will produce new Docker images using a `Dockerfile`.
OKD is designed to run any existing Docker images. Additionally, you can define builds that will produce new Docker images using a `Dockerfile`.

For an easier experience running your source code, [Source-to-Image (S2I)](https://github.com/openshift/source-to-image) allows developers to simply provide an application source repository containing code to build and run. It works by combining an existing S2I-enabled Docker image with application source to produce a new runnable image for your application.

Expand All @@ -93,7 +93,7 @@ Your application image can be easily extended with a database service with our [

### What sorts of security controls does OpenShift provide for containers?

OpenShift runs with the following security policy by default:
OKD runs with the following security policy by default:

* Containers run as a non-root unique user that is separate from other system users
* They cannot access host resources, run privileged, or become root
Expand All @@ -113,15 +113,15 @@ Many Docker containers expect to run as root (and therefore edit all the content
If you are running your own cluster and want to run a container as root, you can grant that permission to the containers in your current project with the following command:

# Gives the default service account in the current project access to run as UID 0 (root)
oc adm add-scc-to-user anyuid -z default
oc adm add-scc-to-user anyuid -z default

See the [security documentation](https://docs.openshift.org/latest/admin_guide/manage_scc.html) more on confining applications.


Support for Kubernetes Alpha Features
-----------------------------------------

Some features from upstream Kubernetes are not yet enabled in OpenShift, for reasons including supportability, security, or limitations in the upstream feature.
Some features from upstream Kubernetes are not yet enabled in OKD, for reasons including supportability, security, or limitations in the upstream feature.

Kubernetes Definitions:

Expand All @@ -135,7 +135,7 @@ Kubernetes Definitions:
* The feature is potentially suitable for limited production use under constrained circumstances.
* The feature is unlikely to be replaced or removed, although it is still possible for feature changes that require migration.

OpenShift uses these terms in the same fashion as Kubernetes, and adds four more:
OKD uses these terms in the same fashion as Kubernetes, and adds four more:

* Not Yet Secure
* Features which are not yet enabled because they have significant security or stability risks to the cluster
Expand All @@ -148,23 +148,23 @@ OpenShift uses these terms in the same fashion as Kubernetes, and adds four more
* Tech Preview
* Features that are considered unsupported for various reasons are known as 'tech preview' in our documentation
* Kubernetes Alpha and Beta features are considered tech preview, although occasionally some features will be graduated early
* Any tech preview feature is not supported in OpenShift Container Platform except through exemption
* Any tech preview feature is not supported in OKD except through exemption
* Disabled Pending Migration
* These are features that are new in Kubernetes but which originated in OpenShift, and thus need migrations for existing users
* We generally try to minimize the impact of features introduced upstream to Kubernetes on OpenShift users by providing seamless
* These are features that are new in Kubernetes but which originated in OKD, and thus need migrations for existing users
* We generally try to minimize the impact of features introduced upstream to Kubernetes on OKD users by providing seamless
migration for existing clusters.
* Generally these are addressed within 1 Kubernetes release

The list of features that qualify under these labels is described below, along with additional context for why.

Feature | Kubernetes | OpenShift | Justification
Feature | Kubernetes | OKD | Justification
------- | ---------- | --------- | -------------
Custom Resource Definitions | GA (1.9) | GA (3.9) |
Custom Resource Definitions | GA (1.9) | GA (3.9) |
Stateful Sets | GA (1.9) | GA (3.9) |
Deployment | GA (1.9) | GA (1.9) |
Replica Sets | GA (1.9) | GA (3.9) | Replica Sets perform the same function as Replication Controllers, but have a more powerful label syntax. Both ReplicationControllers and ReplicaSets can be used.
Ingress | Beta (1.9) | Tech Preview (3.9) | OpenShift launched with Routes, a more full featured Ingress object. Ingress rules can be read by the router (disabled by default), but because Ingress objects reference secrets you must grant the routers access to your secrets manually. Ingress is still beta in upstream Kubernetes.
PodSecurityPolicy | Beta (1.9) | Tech Preview (3.9) | OpenShift launched with SecurityContextConstraints, and then upstreamed them as PodSecurityPolicy. We plan to enable upstream PodSecurityPolicy so as to automatically migrate existing SecurityContextConstraints. PodSecurityPolicy has not yet completed a full security review, which will be part of the criteria for tech preview. <br>SecurityContextConstraints are a superset of PodSecurityPolicy features.
Replica Sets | GA (1.9) | GA (3.9) | Replica Sets perform the same function as Replication Controllers, but have a more powerful label syntax. Both ReplicationControllers and ReplicaSets can be used.
Ingress | Beta (1.9) | Tech Preview (3.9) | OKD launched with Routes, a more full featured Ingress object. Ingress rules can be read by the router (disabled by default), but because Ingress objects reference secrets you must grant the routers access to your secrets manually. Ingress is still beta in upstream Kubernetes.
PodSecurityPolicy | Beta (1.9) | Tech Preview (3.9) | OKD launched with SecurityContextConstraints, and then upstreamed them as PodSecurityPolicy. We plan to enable upstream PodSecurityPolicy so as to automatically migrate existing SecurityContextConstraints. PodSecurityPolicy has not yet completed a full security review, which will be part of the criteria for tech preview. <br>SecurityContextConstraints are a superset of PodSecurityPolicy features.
NetworkPolicy | GA (1.6) | GA (3.7) |

Please contact us if this list omits a feature supported in Kubernetes which does not run in Origin.
Expand All @@ -177,7 +177,7 @@ You can develop [locally on your host](CONTRIBUTING.adoc#develop-locally-on-your

First, **get up and running with the** [**Contributing Guide**](CONTRIBUTING.adoc).

All contributions are welcome - Origin uses the Apache 2 license and does not require any contributor agreement to submit patches. Please open issues for any bugs or problems you encounter, ask questions on the OpenShift IRC channel (#openshift-dev on freenode), or get involved in the [Kubernetes project](https://github.com/kubernetes/kubernetes) at the container runtime layer.
All contributions are welcome - OKD uses the Apache 2 license and does not require any contributor agreement to submit patches. Please open issues for any bugs or problems you encounter, ask questions on the OpenShift IRC channel (#openshift-dev on freenode), or get involved in the [Kubernetes project](https://github.com/kubernetes/kubernetes) at the container runtime layer.

See [HACKING.md](https://github.com/openshift/origin/blob/master/HACKING.md) for more details on developing on Origin including how different tests are setup.

Expand Down Expand Up @@ -224,4 +224,4 @@ https://access.redhat.com/security/team/contact
License
-------

OpenShift is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
OKD is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).