Giter Site home page Giter Site logo

vin / service-catalog Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kubernetes-retired/service-catalog

0.0 2.0 0.0 99.94 MB

Share and consume services in Kubernetes using service brokers

License: Apache License 2.0

Makefile 0.40% Go 89.96% JavaScript 0.89% Shell 5.06% Smarty 0.03% Python 0.05% Ruby 0.27% HTML 0.80% CSS 2.55%

service-catalog's Introduction

service-catalog

Build Status Build Status Go Report Card

Introduction

The service-catalog project is in incubation to bring integration with service brokers to the Kubernetes ecosystem via the Open Service Broker API.

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:

Most applications need a datastore of some kind. The service-catalog allows Kubernetes applications to consume services like databases that exist somewhere in a simple way:

  1. A user wanting to consume a database in their application browses a list of available services in the catalog

  2. The user asks for a new instance of that service to be provisioned

    Provisioning means that the broker somehow creates a new instance of a service. This could mean basically anything that results in a new instance of the service becoming available. Possibilities include: creating a new set of Kubernetes resources in another namespace in the same Kubernetes 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 requests a binding to use the service instance in their application

    Credentials are delivered to users in normal Kubernetes secrets and contain information necessary to connect to and authenticate to the service instance.

For more introduction, including installation and self-guided demo instructions, please see the introduction doc.

For more details about the design and features of this project see the design doc.

Video links


Project Status

We are currently working toward a beta-quality release to be used in conjunction with Kubernetes 1.8. See the milestones list for information about the issues and PRs in current and future milestones.

The project roadmap contains information about our high-level goals for future milestones.

We are currently making weekly releases; see the release process for more information.

Documentation

Our goal is to have extensive use-case and functional documentation.

See the Service Catalog documentation on the main Kubernetes site, and the project documentation here on GitHub.

For details on broker servers that are compatible with this software, see the Open Service Broker API project's Getting Started guide.

Terminology

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

Contributing

Interested in contributing? Check out the contribution guidelines.

Also see the developer's guide for information on how to build and test the code.

We have weekly meetings - see Kubernetes SIGs (search for "Service Catalog") for the exact date and time. For meeting agendas and notes, see Kubernetes SIG Service Catalog Agenda.

Previous meeting notes are also available: 2016-08-29 through 2017-09-17.

Kubernetes Incubator

This is a Kubernetes Incubator project. The project was established 2016-Sept-12. The incubator team for the project is:

For more information about sig-service-catalog, such as meeting times and agenda, check out the community site.

Code of Conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

service-catalog's People

Contributors

agonzalezro avatar arschles avatar ash2k avatar bmelville avatar carolynvs avatar crmejia avatar derekwaynecarr avatar directxman12 avatar dmitri-d avatar duglin avatar gyliu513 avatar jberkhahn avatar jeremyrickard avatar jpeeler avatar juanvallejo avatar kibbles-n-bytes avatar krancour avatar luksa avatar martinmaly avatar mbssaiakhil avatar mhbauer avatar mihnjong-l avatar n3wscott avatar nilebox avatar pmorie avatar richardfung avatar sjenning avatar slack avatar staebler avatar yuexiao-wang avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.