https://github.com/lukasz-antoniak/neo4j-operator

Kubernetes Neo4J Operator
https://github.com/lukasz-antoniak/neo4j-operator

Last synced: about 1 month ago
JSON representation

Kubernetes Neo4J Operator

• Host: GitHub
• URL: https://github.com/lukasz-antoniak/neo4j-operator
• Owner: lukasz-antoniak
• License: apache-2.0
• Created: 2019-07-14T18:37:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-14T18:54:17.000Z (over 5 years ago)
• Last Synced: 2024-05-22T14:31:10.900Z (6 months ago)
• Language: Go
• Size: 24.6 MB
• Stars: 22
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Neo4J Operator

[![License](https://img.shields.io/github/license/lukasz-antoniak/neo4j-operator.svg)](https://raw.githubusercontent.com/lukasz-antoniak/neo4j-operator/master/LICENSE) [![Docker Hub](https://img.shields.io/docker/pulls/lantonia/neo4j-operator.svg)](https://hub.docker.com/r/lantonia/neo4j-operator)

#### Project status: alpha

The project is in alpha phase. While no breaking API changes are currently planned, we reserve the right to address bugs and change the API before the project is declared stable.

## Table of Contents

* [Overview](#overview)

* [Usage](#usage)    

    * [Install the Operator](#install-the-operator)

    * [Deploy Sample Neo4J Cluster](#deploy-sample-neo4j-cluster)

    * [Uninstall the Operator](#uninstall-the-operator)

* [Neo4J Cluster Configuration](#neo4j-cluster-configuration)

    * [Basic](#basic)

    * [SSL Certificates](#ssl-certificates)

    * [Scheduled Backups](#scheduled-backups)

* [Development](#development)

    * [Run the Operator Locally](#run-the-operator-locally)

    * [Build the Operator Image](#build-the-operator-image)

    * [Direct Access to Neo4J Cluster](#direct-access-to-neo4j-cluster)

## Overview

The operator itself has been built with the [Operator framework](https://github.com/operator-framework/operator-sdk) and runs official Neo4J [Docker image](https://hub.docker.com/_/neo4j/).

## Usage

### Install the Operator

Register the `Neo4jCluster` custom resource definition.

    $ kubectl apply -f deploy/crds/database_v1alpha1_neo4jcluster_crd.yaml

You can choose to enable Neo4J operator for all namespaces or just for the a specific one. Examples target default namespace.

Create the operator role, role binding and service account.

    $ kubectl apply -f deploy/role.yaml

    $ kubectl apply -f deploy/role_binding.yaml

    $ kubectl apply -f deploy/service_account.yaml

Operator requires elevated privileges in order to watch for the custom resource updates. On Google Kubernetes Engine, the following command must be run before continuing with installation process. Replace user ID with your own credentials.

    $ cat <