Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Commit

Permalink
Updates to README (#1166)
Browse files Browse the repository at this point in the history
  • Loading branch information
pmorie authored and jpeeler committed Aug 29, 2017
1 parent 57f2aa5 commit 02e0217
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
### Introduction

The service-catalog project is in incubation to bring integration with service
brokers to the Kubernetes ecosystem via the [Open Service Broker
API](https://github.com/openservicebrokerapi/servicebroker). A service broker
is an endpoint that manages a set of services. The end-goal of the service-
catalog project is to provide a way for Kubernetes users to consume services
from brokers and easily configure their applications to use those services,
without needing detailed knowledge about how those services are created /
managed.
brokers to the Kubernetes ecosystem via the [Open Service Broker API](https://github.com/openservicebrokerapi/servicebroker).

A _service broker_ is an endpoint that manages a set of software offerings
called _services_. The end-goal of the service-catalog project is to provide
a way for Kubernetes users to consume services from brokers and easily
configure their applications to use those services, without needing detailed
knowledge about how those services are created or managed.

As an example:

Expand All @@ -32,13 +32,11 @@ _somewhere_ in a simple way:
cluster as the consumer or a different cluster, or even creating a new
tenant in a multi-tenant SaaS system. The point is that the
consumer doesn't have to be aware of or care at all about the details.
3. The user _binds_ that service to their application
3. The user requests a _credential_ to use the service instance in their application

_Binding_ means that the application is injected with the information
necessary to use the service, such as coordinates, credentials, and
configuration items. Applications are injected using the existing
application configuration primitives in Kubernetes: Services, Secrets, and
ConfigMaps.
Credentials are delivered to users in normal Kubernetes secrets and
contain information necessary to connect to and authenticate to the
service instance.

For more details about the design and features of this project see the
[design](docs/design.md) doc.
Expand All @@ -54,11 +52,11 @@ For more details about the design and features of this project see the
### Overall Status

We are currently working toward a beta-quality release to be used in conjunction with
Kubernetes 1.6. See the
Kubernetes 1.8. See the
[milestones list](https://github.com/kubernetes-incubator/service-catalog/milestones?direction=desc&sort=due_date&state=open)
for information about the issues and PRs in current and future milestones.

**NOTE**: Some fields in our API will still be considered **ALPHA** after the
**NOTE**: Some fields in our API may still be considered **ALPHA** after the
API graduates to **BETA**. These fields are prefixed with `alpha` in
JSON/YAML. Alpha fields are provided for use at your own risk, may not work
correctly, may be subject to change or removal at any time, and will not have
Expand All @@ -85,13 +83,12 @@ broker servers that are compatible with this software.
### Terminology

This project's problem domain contains a few inconvenient but unavoidable
overloads with other Kubernetes terms. Check out our [terminology
page](./terminology.md) for definitions of terms as they are used in this
project.
overloads with other Kubernetes terms. Check out our [terminology page](./terminology.md)
for definitions of terms as they are used in this project.

### Contributing

Interested in contributing? Check out the [contributing] documentation(./CONTRIBUTING.md).
Interested in contributing? Check out the [contributing documentation](./CONTRIBUTING.md).

Also see the [developer's guide](./docs/devguide.md) for information on how to
build and test the code.
Expand Down

0 comments on commit 02e0217

Please sign in to comment.