Overview - Contributing to Minishift | Minishift

About
- Welcome
What's New?
- Overview
- Applications
- Cartridges Versus Images
- Terminology
Getting Started
- Overview
- Web Console Walkthrough
- Command-Line Walkthrough
- Setting Up a Cluster
Architecture
- Overview
- Infrastructure Components
- Core Concepts
- Additional Concepts
- Networking
- Service Catalog Components
Container Security Guide
- Introduction
- Container Hosts and Multi-tenancy
- Container Content
- Registries
- Build Process
- Deployment
- Securing the Container Platform
- Network Security
- Attached Storage
- Monitoring Events and Logs
Installing Clusters
- Planning your installation
- System and environment requirements
- Preparing your hosts
- Configuring Your Inventory File
- Example Inventory Files
- Installing OpenShift
- Installing a stand-alone deployment of OpenShift container image registry
- Uninstalling OpenShift
Upgrading Clusters
- Upgrade methods and strategies
- In-place upgrades
- Blue-green upgrades
- Updating operating systems
Configuring Clusters
- Overview
- Setting up the Registry
  - Internal Registry Overview
  - Deploying a Registry on Existing Clusters
  - Accessing the Registry
  - Securing and Exposing the Registry
  - Extended Registry Configuration
  - Known Issues
- Setting up a Router
  - Router Overview
  - Using the Default HAProxy Router
  - Deploying a Customized HAProxy Router
  - Configuring the HAProxy Router to Use the PROXY Protocol
- Deploying Red Hat CloudForms
  - Introduction
  - Requirements
  - Configuring Role Variables
  - Running the Installer
  - Enabling Container Provider Integration
  - Uninstalling
- Prometheus Cluster Monitoring
- Accessing and Configuring the Red Hat Registry
- Master and Node Configuration
- OpenShift Ansible Broker Configuration
- Adding Hosts to an Existing Cluster
- Loading the Default Image Streams and Templates
- Configuring Custom Certificates
- Redeploying Certificates
- Configuring Authentication and User Agent
- Syncing groups with LDAP
- Configuring LDAP failover
- Configuring the SDN
- Configuring Nuage SDN
- Configuring NSX-T SDN
- Configuring Kuryr SDN
- Configuring for AWS
- Configuring for Red Hat Virtualization
- Configuring for OpenStack
- Configuring for Google Compute Engine
- Configuring for Azure
- Configuring for VMware vSphere
- Configuring Local Volumes
- Configuring Persistent Storage
  - Overview
  - Using NFS
  - Using GlusterFS
  - Using OpenStack Cinder
  - Using Ceph RBD
  - Using AWS Elastic Block Store
  - Using GCE Persistent Disk
  - Using iSCSI
  - Using Fibre Channel
  - Using Azure Disk
  - Using Azure File
  - Using FlexVolume
  - Using VMware vSphere volumes for persistent storage
  - Using Local Volume
  - Using Container Storage Interface (CSI)
  - Using OpenStack Manila shares
  - Dynamic Provisioning and Creating Storage Classes
  - Volume Security
  - Selector-Label Volume Binding
  - Enabling Controller-managed Attachment and Detachment
  - Persistent Volume Snapshots
- Persistent Storage Examples
  - Overview
  - Sharing an NFS PV Across Two Pods
  - Using Ceph RBD for Persistent Storage
  - Using Ceph RBD for dynamic provisioning
  - Complete Example Using GlusterFS
  - Complete Example Using GlusterFS for Dynamic Provisioning
  - Mounting Volumes To Privileged Pods
  - Switching an Integrated OpenShift Container Registry to GlusterFS
  - Binding Persistent Volumes by Label
  - Using StorageClasses for Dynamic Provisioning
  - Using StorageClasses for Existing Legacy Storage
  - Configuring Azure Blob Storage for Integrated Container Image Registry
- Configuring Ephemeral Storage
- Working with HTTP Proxies
- Configuring Global Build Defaults and Overrides
- Configuring Pipeline Execution
- Configuring Route Timeouts
- Configuring Native Container Routing
- Routing from Edge Load Balancers
- Aggregating Container Logs
- Aggregate Logging Sizing Guidelines
- Enabling Cluster Metrics
- Customizing the Web Console
- Deploying External Persistent Volume Provisioners
- Installing the Operator Framework (Technology Preview)
Day Two Operations Guide
- Overview
- Run-once tasks
- Environment health checks
- Creating an environment-wide backup
- Host-level tasks
- Project-level tasks
- Docker tasks
- Managing Certificates
Cluster Administration
- Overview
- Managing Nodes
- Restoring your cluster
- Replacing a master host
- Managing Users
- Managing Projects
- Managing Pods
- Managing Networking
- Configuring Service Accounts
- Managing Role-based Access Control
- Image Policy
- Image Signatures
- Scoped Tokens
- Monitoring Images
- Managing Security Context Constraints
- Scheduling
  - Overview
  - Default Scheduling
  - Descheduling
  - Custom Scheduling
  - Controlling Pod Placement
  - Pod Priority and Preemption
  - Advanced Scheduling
  - Advanced Scheduling and Node Affinity
  - Advanced Scheduling and Pod Affinity/Anti-affinity
  - Advanced Scheduling and Node Selectors
  - Advanced Scheduling and Taints and Tolerations
- Setting Quotas
- Setting Multi-Project Quotas
- Setting Limit Ranges
- Pruning objects
- Extending the Kubernetes API with Custom Resources
- Garbage Collection
- Allocating Node Resources
- Node Problem Detector
- Overcommitting
- Assigning Unique External IPs for Ingress Traffic
- Out of Resource Handling
- Monitoring and Debugging Routers
- High Availability
- IPtables
- Securing Builds by Strategy
- Restricting Application Capabilities Using Seccomp
- Sysctls
- Encrypting Data at Datastore Layer
- Encrypting traffic between nodes with IPsec
- Building Dependency Trees
- Replacing a failed etcd member
- Restoring etcd quorum
- Troubleshooting Networking
- Diagnostics Tool
- Idling Applications
- Analyzing Cluster Capacity
- Configuring the cluster auto-scaler in AWS
- Disabling Features using Feature Gates
- Kuryr SDN Administration
Scaling and Performance Guide
- Overview
- Recommended Installation Practices
- Recommended Host Practices
- Optimizing Compute Resources
- Optimizing Persistent Storage
- Optimizing Ephemeral Storage
- Network Optimization
- Routing Optimization
- Scaling Cluster Metrics
- Scaling Cluster Monitoring
- Tested Maximums per Cluster
- Using Cluster Loader
- Using CPU Manager
- Managing Huge Pages
- Optimizing On GlusterFS Storage
Developer Guide
- Overview
- Application Life Cycle Management
  - Planning Your Development Process
  - Creating New Applications
  - Promoting Applications Across Environments
- Authentication
- Authorization
- Projects
- Migrating Applications
  - Overview
  - Database Applications
  - Web Framework Applications
  - QuickStart Examples
  - Continuous Integration and Deployment
  - Webhooks and Action Hooks
  - S2I Tool
  - Support Guide
- Tutorials
  - Overview
  - Quickstart Templates
  - Ruby on Rails
  - Setting Up a Nexus Mirror
  - OpenShift Pipeline Builds
  - Binary Builds
- Builds
  - How Builds Work
  - Basic Build Operations
  - Build Inputs
  - Build Output
  - Build Strategy Options
  - Build Environment
  - Triggering Builds
  - Build Hooks
  - Build Run Policy
  - Advanced Build Operations
  - Troubleshooting
- Deployments
  - How Deployments Work
  - Basic Deployment Operations
  - Deployment Strategies
  - Advanced Deployment Strategies
  - Kubernetes Deployments Support
- Templates
- Opening a Remote Shell to Containers
- Service Accounts
- Managing Images
- Quotas and Limit Ranges
- Getting Traffic into a Cluster
  - Overview
  - Using a Router
  - Using a Load Balancer
  - Using a Service ExternalIP
  - Using a NodePort
- Routes
- Integrating External Services
- Using Device Manager
- Using Device Plug-ins
- Secrets
- ConfigMaps
- Downward API
- Projected Volumes
- Using Daemonsets
- Pod Autoscaling
- Managing Volumes
- Using Persistent Volumes
- Expanding Persistent Volumes
- Executing Remote Commands
- Copying Files
- Port Forwarding
- Shared Memory
- Application Health
- Events
- Managing Environment Variables
- Jobs
- OpenShift Pipeline
- Cron Jobs
- Create from URL
- Creating an object from a custom resource definition
- Application memory sizing
Creating Images
- Overview
- Guidelines
- Image Metadata
- S2I Requirements
- Testing S2I Images
- Custom Builder
Using Images
- Overview
- Source-to-Image (S2I)
  - Overview
  - Java
  - Node.js
  - Perl
  - PHP
  - Python
  - Ruby
  - Customizing S2I Images
- Database Images
  - Overview
  - MySQL
  - PostgreSQL
  - MongoDB
  - MariaDB
- Other Images
CLI Reference
- Overview
- Get Started with the CLI
- Managing CLI Profiles
- Developer CLI Operations
- Administrator CLI Operations
- Differences Between oc and kubectl
- Extending the CLI
Ansible Playbook Bundle Development Guide
- Introduction
- CLI Tooling
- Writing APBs
  - Getting Started
  - Reference
Operators
- Getting started with the Operator SDK
REST API Reference
- Overview
- Examples
- /api/v1
  - v1.APIResourceList
  - v1.APIVersions
  - v1.Binding
  - v1.ComponentStatus
  - v1.ConfigMap
  - v1.Endpoints
  - v1.Event
  - v1.LimitRange
  - v1.Namespace
  - v1.Node
  - v1.PersistentVolume
  - v1.PersistentVolumeClaim
  - v1.Pod
  - v1.PodTemplate
  - v1.ReplicationController
  - v1.ResourceQuota
  - v1.Secret
  - v1.SecurityContextConstraints
  - v1.Service
  - v1.ServiceAccount
- /apis/v1
  - v1.APIGroup
  - v1.APIGroupList
- /apis/apps/v1beta1
  - v1beta1.ControllerRevision
  - v1beta1.Deployment
  - v1beta1.StatefulSet
- /apis/autoscaling/v1
  - v1.HorizontalPodAutoscaler
- /apis/batch/v1
  - v1.Job
- /apis/batch/v2alpha1
  - v2alpha1.CronJob
  - v2alpha1.ScheduledJob
- /apis/extensions/v1beta1
  - v1beta1.DaemonSet
  - v1beta1.Deployment
  - v1beta1.Ingress
  - v1beta1.NetworkPolicy
  - v1beta1.PodSecurityPolicy
  - v1beta1.ReplicaSet
  - v1beta1.ThirdPartyResource
- /apis/policy/v1beta1
  - v1beta1.PodDisruptionBudget
- /apis/authentication.k8s.io/v1
  - v1.TokenReview
- /apis/authentication.k8s.io/v1beta1
  - v1beta1.TokenReview
- /apis/authorization.k8s.io/v1
  - v1.LocalSubjectAccessReview
  - v1.SelfSubjectAccessReview
  - v1.SubjectAccessReview
- /apis/authorization.k8s.io/v1beta1
  - v1beta1.LocalSubjectAccessReview
  - v1beta1.SelfSubjectAccessReview
  - v1beta1.SubjectAccessReview
- /apis/rbac.authorization.k8s.io/v1beta1
  - v1beta1.ClusterRole
  - v1beta1.ClusterRoleBinding
  - v1beta1.Role
  - v1beta1.RoleBinding
- /apis/certificates.k8s.io/v1beta1
  - v1beta1.CertificateSigningRequest
- /apis/networking.k8s.io/v1
  - v1.NetworkPolicy
- /apis/storage.k8s.io/v1
  - v1.StorageClass
- /apis/storage.k8s.io/v1beta1
  - v1beta1.StorageClass
- /apis/apps.openshift.io/v1
  - v1.DeploymentConfig
- /apis/authorization.openshift.io/v1
  - v1.ClusterRole
  - v1.ClusterRoleBinding
  - v1.LocalResourceAccessReview
  - v1.LocalSubjectAccessReview
  - v1.ResourceAccessReview
  - v1.Role
  - v1.RoleBinding
  - v1.RoleBindingRestriction
  - v1.SelfSubjectRulesReview
  - v1.SubjectAccessReview
  - v1.SubjectRulesReview
- /apis/build.openshift.io/v1
  - v1.Build
  - v1.BuildConfig
- /apis/image.openshift.io/v1
  - v1.Image
  - v1.ImageSignature
  - v1.ImageStream
  - v1.ImageStreamImage
  - v1.ImageStreamImport
  - v1.ImageStreamMapping
  - v1.ImageStreamTag
- /apis/network.openshift.io/v1
  - v1.ClusterNetwork
  - v1.EgressNetworkPolicy
  - v1.HostSubnet
  - v1.NetNamespace
- /apis/oauth.openshift.io/v1
  - v1.OAuthAccessToken
  - v1.OAuthAuthorizeToken
  - v1.OAuthClient
  - v1.OAuthClientAuthorization
- /apis/project.openshift.io/v1
  - v1.Project
  - v1.ProjectRequest
- /apis/quota.openshift.io/v1
  - v1.AppliedClusterResourceQuota
  - v1.ClusterResourceQuota
- /apis/route.openshift.io/v1
  - v1.Route
- /apis/security.openshift.io/v1
  - v1.PodSecurityPolicyReview
  - v1.PodSecurityPolicySelfSubjectReview
  - v1.PodSecurityPolicySubjectReview
  - v1.SecurityContextConstraints
- /apis/template.openshift.io/v1
  - v1.BrokerTemplateInstance
  - v1.Template
  - v1.TemplateInstance
- /apis/user.openshift.io/v1
  - v1.Group
  - v1.Identity
  - v1.User
  - v1.UserIdentityMapping
- /oapi/v1
  - v1.AppliedClusterResourceQuota
  - v1.Build
  - v1.BuildConfig
  - v1.ClusterNetwork
  - v1.ClusterResourceQuota
  - v1.ClusterRole
  - v1.ClusterRoleBinding
  - v1.DeploymentConfig
  - v1.DeploymentConfigRollback
  - v1.EgressNetworkPolicy
  - v1.Group
  - v1.HostSubnet
  - v1.Identity
  - v1.Image
  - v1.ImageSignature
  - v1.ImageStream
  - v1.ImageStreamImage
  - v1.ImageStreamImport
  - v1.ImageStreamMapping
  - v1.ImageStreamTag
  - v1.LocalResourceAccessReview
  - v1.LocalSubjectAccessReview
  - v1.NetNamespace
  - v1.OAuthAccessToken
  - v1.OAuthAuthorizeToken
  - v1.OAuthClient
  - v1.OAuthClientAuthorization
  - v1.PodSecurityPolicyReview
  - v1.PodSecurityPolicySelfSubjectReview
  - v1.PodSecurityPolicySubjectReview
  - v1.ProcessedTemplate
  - v1.Project
  - v1.ProjectRequest
  - v1.ResourceAccessReview
  - v1.Role
  - v1.RoleBinding
  - v1.RoleBindingRestriction
  - v1.Route
  - v1.SelfSubjectRulesReview
  - v1.SubjectAccessReview
  - v1.SubjectRulesReview
  - v1.Template
  - v1.User
  - v1.UserIdentityMapping
CRI-O Runtime
- Using the CRI-O Container Engine
Minishift
- Overview
- Getting Started
- Using Minishift
- Interacting with OpenShift
- Troubleshooting Minishift
- Contributing to Minishift
- Command Reference

Join the Minishift community! Learn about the project and how to contribute.

You can reach the Minishift community by:

Signing up to our mailing list
Joining the #minishift channel on Freenode IRC