installers/charm/osm-keystone/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
  16 # Keystone Operator
  17
  18 [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black/tree/main)
  19
  20 [![Keystone](https://charmhub.io/osm-keystone/badge.svg)](https://charmhub.io/osm-keystone)
  21
  22 ## Description
  23
  24 This charm deploys Keystone in K8s. It is mainly developed to be used as part of the OSM deployment.
  25
  26 ## Usage
  27
  28 The Keystone Operator may be deployed using the Juju command line as in
  29
  30 ```shell
  31 $ juju add-model keystone
  32 $ juju deploy charmed-osm-mariadb-k8s db
  33 $ juju deploy osm-keystone --trust
  34 $ juju relate osm-keystone db
  35 ```
  36
  37 ## OCI Images
  38
  39 - [keystone](https://hub.docker.com/r/opensourcemano/keystone)
  40
  41 ## Contributing
  42
  43 Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines
  44 on enhancements to this charm following best practice guidelines, and
  45 `CONTRIBUTING.md` for developer guidance.