 Source Files
      ¶
      Source Files
      ¶
    
- doc.go
       Directories
      ¶
      Directories
      ¶
    
    | Path | Synopsis | 
|---|---|
| Package api includes all OpenShift-specific types used to communicate between the various parts of the OpenShift and the Kubernetes systems. | Package api includes all OpenShift-specific types used to communicate between the various parts of the OpenShift and the Kubernetes systems. | 
| 
          
            latest
            
            
          
           Package latest defines the default output serializations that code should use and imports the required schemas. | Package latest defines the default output serializations that code should use and imports the required schemas. | 
| 
          
            v1
            
            
          
           Package v1 is the v1 version of the API. | Package v1 is the v1 version of the API. | 
| 
          
            v1beta3
            
            
          
           Package v1beta3 is the v1beta3 version of the API. | Package v1beta3 is the v1beta3 version of the API. | 
| Package auth provides mechanisms for providing authorization and authentication to OpenShift | Package auth provides mechanisms for providing authorization and authentication to OpenShift | 
| 
          
            authenticator/password/basicauthpassword
            
            
          
           Package basicauthpassword implements authenticator.Password by making a BasicAuth call to a remote endpoint and extracting user information from a JSON response. | Package basicauthpassword implements authenticator.Password by making a BasicAuth call to a remote endpoint and extracting user information from a JSON response. | 
| 
          
            authenticator/password/keystonepassword
            
            
          
           Package keystone provide authentication via keystone. | Package keystone provide authentication via keystone. | 
| 
          
            authenticator/request/x509request
            
            
          
           Package x509request provides a request authenticator that validates and extracts user information from client certificates | Package x509request provides a request authenticator that validates and extracts user information from client certificates | 
| 
          
            oauth/external
            
            
          
           Package external implements an OAuth flow with an external identity provider | Package external implements an OAuth flow with an external identity provider | 
| authorization
       | |
| Package build contains the OpenShift build system. | Package build contains the OpenShift build system. | 
| 
          
            admission
            
            
          
           Package admission contains admission control plugins that work with builds or pods that are running builds. | Package admission contains admission control plugins that work with builds or pods that are running builds. | 
| 
          
            admission/defaults
            
            
          
           Package defaults contains the BuildDefaults admission control plugin. | Package defaults contains the BuildDefaults admission control plugin. | 
| 
          
            admission/overrides
            
            
          
           Package overrides contains the BuildOverrides admission control plugin. | Package overrides contains the BuildOverrides admission control plugin. | 
| 
          
            builder
            
            
          
           Package builder contains builders for STI and Docker in OpenShift Origin | Package builder contains builders for STI and Docker in OpenShift Origin | 
| 
          
            builder/cmd
            
            
          
           Package cmd contains the main entry point for the docker and STI builders | Package cmd contains the main entry point for the docker and STI builders | 
| 
          
            builder/cmd/dockercfg
            
            
          
           Package dockercfg contains a command helper to read .dockercfg files | Package dockercfg contains a command helper to read .dockercfg files | 
| 
          
            builder/cmd/scmauth
            
            
          
           Package scmauth provides SCM authentication methods based on secret files | Package scmauth provides SCM authentication methods based on secret files | 
| 
          
            generator
            
            
          
           Package generator contains the code to generate Build from BuildConfig as well as REST support to help expose the generator from an API. | Package generator contains the code to generate Build from BuildConfig as well as REST support to help expose the generator from an API. | 
| 
          
            reaper
            
            
          
           Package reaper implements the Reaper interface for buildConfigs | Package reaper implements the Reaper interface for buildConfigs | 
| 
          
            util
            
            
          
           Package util contains common functions that are used by the rest of the OpenShift build system. | Package util contains common functions that are used by the rest of the OpenShift build system. | 
| 
          
            webhook
            
            
          
           Package webhook contains code for managing and serving webhook services, providing post push events to trigger builds. | Package webhook contains code for managing and serving webhook services, providing post push events to trigger builds. | 
| 
          
            webhook/generic
            
            
          
           Package generic contains webhook.Plugin implementation of a generic webhooks for use in testing and/or other ad/hoc usage | Package generic contains webhook.Plugin implementation of a generic webhooks for use in testing and/or other ad/hoc usage | 
| 
          
            webhook/github
            
            
          
           Package github contains webhook.Plugin implementation of github webhooks according to https://developer.github.com/webhooks/ | Package github contains webhook.Plugin implementation of github webhooks according to https://developer.github.com/webhooks/ | 
| cmd
       | |
| 
          
            admin/diagnostics
            
            
          
           OpenShift v3 Diagnostics | OpenShift v3 Diagnostics | 
| 
          
            flagtypes
            
            
          
           Package flagtypes provides types that implement the pflags.Value interface for converting command line flags to objects. | Package flagtypes provides types that implement the pflags.Value interface for converting command line flags to objects. | 
| 
          
            infra/builder
            
            
          
           Package builder contains commands for running a Source-to-Images or Docker build from within a container | Package builder contains commands for running a Source-to-Images or Docker build from within a container | 
| 
          
            server/etcd
            
            
          
           Package etcd provides objects for creating an embedded etcd server process. | Package etcd provides objects for creating an embedded etcd server process. | 
| 
          
            server/etcd/etcdserver
            
            
          
           This is a somewhat faithful reproduction of etcdmain/etcd.go | This is a somewhat faithful reproduction of etcdmain/etcd.go | 
| 
          
            server/kubernetes
            
            
          
           Package kubernetes provides objects for starting the Kubernetes master and node code. | Package kubernetes provides objects for starting the Kubernetes master and node code. | 
| 
          
            server/origin
            
            
          
           Package origin provides objects for creating an OpenShift Origin server | Package origin provides objects for creating an OpenShift Origin server | 
| 
          
            util
            
            
          
           Package util provides utility functions for the cmd packages. | Package util provides utility functions for the cmd packages. | 
| config
       | |
| Package controller provides reusable support for controller implementations. | Package controller provides reusable support for controller implementations. | 
| Package deploy contains logic for watching and synchronizing deployments from configuration. | Package deploy contains logic for watching and synchronizing deployments from configuration. | 
| 
          
            controller
            
            
          
           Package controller contains all the controllers which taken together implement the deployment system's behavior. | Package controller contains all the controllers which taken together implement the deployment system's behavior. | 
| 
          
            generator
            
            
          
           Package generator contains the code for DeploymentConfig regeneration as well as REST support to help expose the generator from an API. | Package generator contains the code for DeploymentConfig regeneration as well as REST support to help expose the generator from an API. | 
| 
          
            graph/analysis
            
            
          
           Package analysis provides functions that analyse deployment configurations and setup markers that will be reported by oc status | Package analysis provides functions that analyse deployment configurations and setup markers that will be reported by oc status | 
| 
          
            reaper
            
            
          
           Package reaper implements the Reaper interface for deploymentConfigs | Package reaper implements the Reaper interface for deploymentConfigs | 
| 
          
            registry/deployconfig
            
            
          
           Package deployconfig provides Registry interface and its RESTStorage implementation for storing DeploymentConfig api objects. | Package deployconfig provides Registry interface and its RESTStorage implementation for storing DeploymentConfig api objects. | 
| 
          
            registry/deploylog
            
            
          
           Package deploylog provides a Registry interface for retrieving deployment logs | Package deploylog provides a Registry interface for retrieving deployment logs | 
| 
          
            registry/rollback
            
            
          
           Package rollback contains the code for generating DeploymentConfigs representing rollbacks as well as REST support for API clients. | Package rollback contains the code for generating DeploymentConfigs representing rollbacks as well as REST support for API clients. | 
| 
          
            scaler
            
            
          
           Package scaler implements the kubectl.Scaler interface for deploymentConfigs | Package scaler implements the kubectl.Scaler interface for deploymentConfigs | 
| 
          
            strategy
            
            
          
           Package strategy contains implementations of core deployment strategies. | Package strategy contains implementations of core deployment strategies. | 
| 
          
            strategy/support
            
            
          
           Package support is a library of code useful to any strategy. | Package support is a library of code useful to any strategy. | 
| diagnostics
       | |
| 
          
            server
            
            
          
           Package server wraps repository and blob store objects of docker/distribution upstream. | Package server wraps repository and blob store objects of docker/distribution upstream. | 
| generate
       | |
| 
          
            app
            
            
          
           Package app defines reference objects used to generate OpenShift API objects | Package app defines reference objects used to generate OpenShift API objects | 
| 
          
            dockerfile
            
            
          
           Package dockerfile provides utilities for finding and parsing Dockerfiles | Package dockerfile provides utilities for finding and parsing Dockerfiles | 
| 
          
            errors
            
            
          
           Package errors defines errors thrown during config generation | Package errors defines errors thrown during config generation | 
| 
          
            git
            
            
          
           Package git allows working with Git repositories | Package git allows working with Git repositories | 
| 
          
            source
            
            
          
           Package source includes detectors for STI source repositories | Package source includes detectors for STI source repositories | 
| Package gitserver provides a smart Git HTTP server that can also set and remove hooks. | Package gitserver provides a smart Git HTTP server that can also set and remove hooks. | 
| Package image provides support for images, image repositories, and image repository mappings, including RESTStorage implementations and registries. | Package image provides support for images, image repositories, and image repository mappings, including RESTStorage implementations and registries. | 
| oauth
       | |
| 
          
            api/validation
            
            
          
           Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid. | Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid. | 
| 
          
            osintypes
            
            
          
           osintypes holds types that are used to interpret responses from the RangelReale osin server. | osintypes holds types that are used to interpret responses from the RangelReale osin server. | 
| Package project provides support for projects including RESTStorage implementations and registries. | Package project provides support for projects including RESTStorage implementations and registries. | 
| 
          
            auth
            
            
          
           Package auth provides mechanisms for enforcing authorization to Project resources in OpenShift | Package auth provides mechanisms for enforcing authorization to Project resources in OpenShift | 
| 
          
            admission/runonceduration
            
            
          
           Package runonceduration contains the RunOnceDuration admission control plugin. | Package runonceduration contains the RunOnceDuration admission control plugin. | 
| 
          
            image
            
            
          
           Package image implements evaluators of usage for images stored in an internal registry. | Package image implements evaluators of usage for images stored in an internal registry. | 
| Package route provides support for managing and watching routes. | Package route provides support for managing and watching routes. | 
| 
          
            allocation
            
            
          
           Package allocation contains all the route allocation plugins. | Package allocation contains all the route allocation plugins. | 
| 
          
            allocation/simple
            
            
          
           Package simple contains the SimpleAllocation route plugin. | Package simple contains the SimpleAllocation route plugin. | 
| 
          
            controller
            
            
          
           Package controller contains all the route handling controllers. | Package controller contains all the route handling controllers. | 
| 
          
            controller/allocation
            
            
          
           Package allocation contains all the route allocation controllers. | Package allocation contains all the route allocation controllers. | 
| 
          
            generator
            
            
          
           Package generator implements the Generator interface for routes | Package generator implements the Generator interface for routes | 
| 
          
            graph
            
            
          
           Package graph contains graph utilities for routes | Package graph contains graph utilities for routes | 
| 
          
            graph/analysis
            
            
          
           Package analysis provides functions that analyse routes and setup markers that will be reported by oc status | Package analysis provides functions that analyse routes and setup markers that will be reported by oc status | 
| 
          
            graph/nodes
            
            
          
           Package nodes contains graph functions and types for routes | Package nodes contains graph functions and types for routes | 
| Package router contains the abstraction for router backend implementations. | Package router contains the abstraction for router backend implementations. | 
| 
          
            controller
            
            
          
           Package controller contains the router controller. | Package controller contains the router controller. | 
| 
          
            controller/factory
            
            
          
           Package factory contains code used to create the router controller. | Package factory contains code used to create the router controller. | 
| scheduler
       | |
| sdn
       | |
| Package template provides TemplateProcessor, capable of transforming Template objects into Config objects. | Package template provides TemplateProcessor, capable of transforming Template objects into Config objects. | 
| 
          
            api
            
            
          
           Package api defines and registers types for Template objects. | Package api defines and registers types for Template objects. | 
| 
          
            api/validation
            
            
          
           Package validation has functions for validating the correctness of Template objects and explaining what is wrong with them when they aren't valid. | Package validation has functions for validating the correctness of Template objects and explaining what is wrong with them when they aren't valid. | 
| 
          
            generator
            
            
          
           Package generator defines GeneratorInterface interface and implements some random value generators. | Package generator defines GeneratorInterface interface and implements some random value generators. | 
| 
          
            generator/examples
            
            
          
           Package examples demonstrates possible implementation of some random value generators. | Package examples demonstrates possible implementation of some random value generators. | 
| Package util implements various utility functions used in both testing and implementation of OpenShift. | Package util implements various utility functions used in both testing and implementation of OpenShift. | 
| 
          
            docker
            
            
          
           Package docker has utilities to work with Docker. | Package docker has utilities to work with Docker. | 
| 
          
            docker/dockerfile
            
            
          
           Package dockerfile has utilities that complement Docker's official Dockerfile parser. | Package dockerfile has utilities that complement Docker's official Dockerfile parser. | 
| 
          
            errors
            
            
          
           Package errors provides utility functions for various errors | Package errors provides utility functions for various errors | 
| 
          
            file
            
            
          
           Package file implements utility functions used to work with arbitrary files. | Package file implements utility functions used to work with arbitrary files. | 
| 
          
            httpproxy
            
            
          
           Package httpproxy contains an upgrade-aware HTTP single-host reverse proxy. | Package httpproxy contains an upgrade-aware HTTP single-host reverse proxy. | 
| 
          
            labelselector
            
            
          
           labelselector is trim down version of k8s/pkg/labels/selector.go It only accepts exact label matches Example: "k1=v1, k2 = v2" | labelselector is trim down version of k8s/pkg/labels/selector.go It only accepts exact label matches Example: "k1=v1, k2 = v2" | 
| 
          
            namer
            
            
          
           Package namer contains a name generator for unique names | Package namer contains a name generator for unique names | 
| Package version supplies version information collected at build time to OpenShift and Kubernetes components. | Package version supplies version information collected at build time to OpenShift and Kubernetes components. | 
| volume
       | |
 Click to show internal directories. 
   Click to hide internal directories.