installers/charm/mariadb-k8s/README.md

   1 <!-- Copyright 2021 Canonical Ltd.
   2
   3 Licensed under the Apache License, Version 2.0 (the "License"); you may
   4 not use this file except in compliance with the License. You may obtain
   5 a copy of the License at
   6
   7         http://www.apache.org/licenses/LICENSE-2.0
   8
   9 Unless required by applicable law or agreed to in writing, software
  10 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12 License for the specific language governing permissions and limitations
  13 under the License.
  14
  15 For those usages not covered by the Apache License, Version 2.0 please
  16 contact: legal@canonical.com
  17
  18 To get in touch with the maintainers, please contact:
  19 osm-charmers@lists.launchpad.net -->
  20
  21 # MariaDB Operator
  22
  23 A Juju charm deploying and managing MariaDB on Kubernetes.
  24
  25 ## Overview
  26
  27 MariaDB turns data into structured information in a wide array of
  28 applications, ranging from banking to websites. Originally designed as
  29 enhanced, drop-in replacement for MySQL, MariaDB is used because it is fast,
  30 scalable and robust, with a rich ecosystem of storage engines, plugins and
  31 many other tools make it very versatile for a wide variety of use cases.
  32
  33 MariaDB is developed as open source software and as a relational database it
  34 provides an SQL interface for accessing data. The latest versions of MariaDB
  35 also include GIS and JSON features.
  36
  37 More information can be found in [the MariaDB Knowledge Base](https://mariadb.com/kb/en/documentation/).
  38
  39 ## Usage
  40
  41 For details on using Kubernetes with Juju [see here](https://juju.is/docs/kubernetes), and for
  42 details on using Juju with MicroK8s for easy local testing [see here](https://juju.is/docs/microk8s-cloud).
  43
  44 To deploy the charm into a Juju Kubernetes model:
  45
  46     juju deploy cs:~charmed-osm/mariadb
  47
  48 The charm can then be easily related to an application that supports the mysql
  49 relation, such as:
  50
  51     juju deploy cs:~charmed-osm/keystone
  52     juju relate keystone mariadb-k8s
  53
  54 Once the "Workload" status of both mariadb-k8s and keystone is "active", using
  55 the "Application" IP of keystone (from `juju status`):
  56
  57     # Change as appropriate for you juju model
  58     KEYSTONE_APPLICATION_IP=10.152.183.222
  59     curl -i -H "Content-Type: application/json" -d '
  60     { "auth": {
  61         "identity": {
  62           "methods": ["password"],
  63           "password": {
  64             "user": {
  65               "name": "admin",
  66               "domain": { "id": "default" },
  67              "password": "admin"
  68            }
  69          }
  70        }
  71      }
  72     ' "http://${KEYSTONE_APPLICATION_IP}:5000/v3/auth/tokens" ; echo
  73
  74 This will create a token that you could use to query Keystone.
  75
  76 ---
  77
  78 For more details, [see here](https://charmhub.io/mariadb/docs/).