installers/charm/vca-integrator-operator/README.md

   1 <!--
   2 Copyright ETSI Contributors and Others.
   3 Licensed under the Apache License, Version 2.0 (the "License");
   4 you may not use this file except in compliance with the License.
   5 You may obtain 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,
  11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  12 implied.
  13 See the License for the specific language governing permissions and
  14 limitations under the License.
  15 -->
  16
  17 # OSM VCA Integrator Operator
  18
  19 ## Description
  20
  21 TODO
  22
  23 ## How-to guides
  24
  25 ### Deploy and configure
  26
  27 Deploy the OSM VCA Integrator Charm using the Juju command line:
  28
  29 ```shell
  30 $ juju add-model osm-vca-integrator
  31 $ juju deploy osm-vca-integrator
  32 $ juju config osm-vca-integrator \
  33     k8s-cloud=microk8s \
  34     controllers="`cat ~/.local/share/juju/controllers.yaml`" \
  35     accounts="`cat ~/.local/share/juju/accounts.yaml`" \
  36     public-key="`cat ~/.local/share/juju/ssh/juju_id_rsa.pub`"
  37 ```
  38
  39 ## Contributing
  40
  41 Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines
  42 on enhancements to this charm following best practice guidelines, and
  43 `CONTRIBUTING.md` for developer guidance.