Latest Documentation Minishift REST API Reference

Latest Documentation

About

Welcome

Overview Applications Cartridges Versus Images Terminology

Getting Started

Overview Web Console Walkthrough Command-Line Walkthrough Setting Up a Cluster

Overview Infrastructure Components

Kubernetes Infrastructure Container Registry Web Console

Core Concepts

Overview Containers and Images Pods and Services Projects and Users Builds and Image Streams Deployments Templates

Additional Concepts

Authentication Authorization Persistent Storage Ephemeral Storage Source Control Management Admission Controllers Custom Admission Controllers Other API Objects

Networking

Networking OpenShift SDN Available SDN plug-ins Available router plug-ins Port Forwarding Remote Commands Routes

Service Catalog Components

Service Catalog Service Catalog CLI Template Service Broker OpenShift Ansible Broker AWS Service Broker

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 Using the F5 Router Plug-in

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 Monitoring OpenShift with Dynatrace

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 Opaque Integer 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

Overview Source-to-Image (S2I)

Overview Node.js Perl PHP Python Ruby Wildfly Customizing S2I Images

Database Images

Overview MySQL PostgreSQL MongoDB MariaDB

Other Images

Overview Jenkins Jenkins Slaves Other Container Images

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

Getting started with the Operator SDK Operators based on Helm charts Operator SDK CLI reference Migrating to Operator SDK v0.1.0 Appendices

Using the CRI-O Container Engine

Overview

2020-02-15

Overview

This guide covers further configuration options available for your OKD cluster post-installation.

▴ Configuring Clusters

Setting up the Registry ▸