tests/charms/layers/simple/README.md

   1 # Overview
   2
   3 This is an example charm as demonstrated in the OSM [Hackfest](https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events) series.
   4
   5 This is intended to provide a well-documented example of the proxy charm written by Hackfest participants.
   6
   7 # Prerequisites
   8
   9 There are two ways that you can exercise this charm: install the latest stable release of OSM or use Juju directly.
  10
  11 The workshop materials and tutorials cover using charms as part of OSM. You can follow that approach, but this README will focus on using Juju directly. We highly recommend that vendors and charm developers use this approach for the initial development of the charm.
  12
  13 ## Ubuntu 16.04 or higher
  14
  15 We recommend using Ubuntu 16.04 or higher for the development and testing of charms. It is assumed that you have installed Ubuntu either on physical hardware or in a Virtual Machine.
  16
  17 ## Install LXD and Juju
  18
  19 We will be installing the required software via snap. Snaps are containerised software packages, preferred because they are easy to create and install, will automatically update to the latest stable version, and contain bundled dependencies.
  20
  21 ```
  22 snap install lxd
  23 snap install juju
  24 snap install charm
  25 ```
  26
  27 # Usage
  28
  29
  30 ## Known Limitations and Issues
  31
  32 This not only helps users but gives people a place to start if they want to help
  33 you add features to your charm.
  34
  35 # Configuration
  36
  37 The configuration options will be listed on the charm store, however If you're
  38 making assumptions or opinionated decisions in the charm (like setting a default
  39 administrator password), you should detail that here so the user knows how to
  40 change it immediately, etc.
  41
  42 # Contact Information
  43
  44 ## Upstream Project Name
  45
  46   - Upstream website
  47   - Upstream bug tracker
  48   - Upstream mailing list or contact information
  49   - Feel free to add things if it's useful for users
  50
  51
  52 [service]: http://example.com
  53 [icon guidelines]: https://jujucharms.com/docs/stable/authors-charm-icon