Skip to content

Latest commit

 

History

History
159 lines (127 loc) · 5.54 KB

install.md

File metadata and controls

159 lines (127 loc) · 5.54 KB
Raw

Installing OLM

OLM deployment resources are templated so that they can be easily configured for different deployment environments.

Install the latest released version of OLM for upstream Kubernetes

kubectl apply -f deploy/upstream/manifests/0.4.0

Install the latest released version of OLM for Tectonic

Tectonic releases live in versioned folders in the manifests directory. The simplest way to install OLM in a cluster is to:

# Packaged releases of OLM are installed in tectonic-system by default
kubectl create namespace tectonic-system
# Install the release
kubectl apply -f deploy/tectonic-alm-operator/manifests/0.4.0

Install with Ansible for openshift

OLM should be installed via openshift-ansible. The playbook in this repo is periodically synced with openshift-ansible and should only be used for testing releases.

The playbook assumes that the hosts file has the same format as openshift-ansible

ansible-playbook -i path/to/hosts deploy/aos-olm/playbook/config.yaml

Run locally with minikube

This command starts minikube, builds the OLM containers locally with the minikube-provided docker, and uses the local configuration in local-values.yaml to build localized deployment resources for OLM.

make run-local

You can verify that the OLM components have been successfully deployed by running kubectl -n local get deployments

Run locally with minishift

This command starts minishift, builds the OLM containers locally with the minishift-provided docker, and uses the local configuration in local-values-shift.yaml to build localized deployment resources for OLM.

make run-local-shift

You can verify that the OLM components have been successfully deployed by running kubectl -n local get deployments

Building deployment resources for any cluster

Deployments of OLM can be stamped out with different configurations by writing a values.yaml file and running commands to generate resources.

Here's an example values.yaml

# sets the apiversion to use for rbac-resources. Change to `authorization.openshift.io` for openshift
rbacApiVersion: rbac.authorization.k8s.io
# namespace is the namespace the operators will _run_
namespace: local
# watchedNamespaces is a comma-separated list of namespaces the operators will _watch_ for OLM resources.
# Omit to enable OLM in all namespaces
watchedNamespaces: local
# catalog_namespace is the namespace where the catalog operator will look for global catalogs.
# entries in global catalogs can be resolved in any watched namespace
catalog_namespace: local

# OLM operator run configuration
alm:
  # OLM operator doesn't do any leader election (yet), set to 1
  replicaCount: 1
  # The image to run. If not building a local image, use sha256 image references
  image:
    ref: quay.io/coreos/olm:local
    pullPolicy: IfNotPresent
  service:
    # port for readiness/liveness probes
    internalPort: 8080

# catalog operator run configuration
catalog:
  # Catalog operator doesn't do any leader election (yet), set to 1
  replicaCount: 1
  # The image to run. If not building a local image, use sha256 image references
  image:
    ref: quay.io/coreos/catalog:local
    pullPolicy: IfNotPresent
  service:
    # port for readiness/liveness probes
    internalPort: 8080

# alm service broker run configuration
servicebroker:
  # OLM Service Broker doesn't need to be HA; scale with load
  replicaCount: 1
  image:
    ref: quay.io/coreos/olm-service-broker:local
    pullPolicy: IfNotPresent
  service:
    # port for readiness/liveness probes
    internalPort: 8080
    # port exposing OLM's service broker API
    brokerPort: 8005

To configure a release of OLM for installation in a cluster:

  1. Create a my-values.yaml like the example above with the desired configuration or choose an existing one from this repository. The latest production values can be found in deploy/tectonic-alm-operator/values.yaml.
  2. Generate deployment files from the templates and the my-values.yaml using package-release.sh 
    # first arg must be a semver-compatible version string
# second arg is the output directory
# third arg is the values.yaml file
./scripts/package-release.sh 1.0.0-myolm ./my-olm-deployment my-values.yaml
  3. Deploy to kubernetes: kubectl apply -f ./my-olm-deployment/templates/

The above steps are automated for official releases with make ver=0.3.0 release, which will output new versions of manifests in deploy/tectonic-alm-operator/manifests/$(ver).

Subscribe to a Package and Channel

Cloud Services can be installed from the catalog by subscribing to a channel in the corresponding package.

If using one of the local run options, this will subscribe to etcd, vault, and prometheus operators. Subscribing to a service that doesn't exist yet will install the operator and related CRDs in the namespace.

apiVersion: app.coreos.com/v1alpha1
kind: Subscription-v1
metadata:
  name: etcd
  namespace: local
spec:
  channel: alpha
  name: etcd
  source: tectonic-ocs
---
apiVersion: app.coreos.com/v1alpha1
kind: Subscription-v1
metadata:
  name: vault
  namespace: local
spec:
  channel: alpha
  name: vault
  source: tectonic-ocs
---
apiVersion: app.coreos.com/v1alpha1
kind: Subscription-v1
metadata:
  name: prometheus
  namespace: local
spec:
  channel: alpha
  name: prometheus
  source: tectonic-ocs