ocean-operator

README

Ocean Operator for Kubernetes

Ocean Operator for Kubernetes is an Operator that makes use of custom resources and can be used to create and manage Ocean components.

Table of Contents

• Installation
• Documentation
• Getting Help
• Community
• Contributing
• License

Installation

Install with Spot CLI

Prerequisites

• Install the Spot CLI.

Steps

1. Install ocean-operator:

spotctl ocean install \
  --set spotinst.token=REDACTED \
  --set spotinst.account=REDACTED \
  --set spotinst.clusterIdentifier=REDACTED \
  --namespace spot-system
  # [...]

Verify

Ensure all Kubernetes Pods in spot-system namespace are deployed and have a STATUS of Running:

kubectl get pods -n spot-system

Install with Helm

Prerequisites

• Install a Helm client with a version 3 or later.

Steps

1. Add the Spot Helm repository:

helm repo add spot https://charts.spot.io

1. Update your local Helm chart repository cache:

helm repo update

1. Install ocean-operator:

helm install my-release spot/ocean-operator \
  --set spotinst.token=REDACTED \
  --set spotinst.account=REDACTED \
  --set spotinst.clusterIdentifier=REDACTED \
  --namespace spot-system \
  --create-namespace \
  # [...]

Verify

Ensure all Kubernetes Pods in spot-system namespace are deployed and have a STATUS of Running:

kubectl get pods -n spot-system

Documentation

If you're new to Spot and want to get started, please checkout our Getting Started guide, available on the Spot Documentation website.

Getting Help

We use GitHub issues for tracking bugs and feature requests. Please use these community resources for getting help:

• Ask a question on Stack Overflow and tag it with ocean-operator.
• Join our Spot community on Slack.
• Open an issue.

Community

• Slack
• Twitter

Contributing

Please see the contribution guidelines.

License

Code is licensed under the Apache License 2.0.