README clean up
PROD-13805
Change-Id: Iedb0fde25ff8258e285e7a07927819f01591413a
diff --git a/README.rst b/README.rst
index b179bec..e099f11 100644
--- a/README.rst
+++ b/README.rst
@@ -1,176 +1,143 @@
=====
-Aptly
+Usage
=====
-Install and configure Aptly server and client.
+The Aptly formula configures and installs the Aptly server and client.
-Available states
-================
+The available states include:
-.. contents::
- :local:
+* ``aptly.server``
+* ``aptly.publisher``
-``aptly.server``
-----------------
+The available metadata include:
-Setup aptly server
+* ``metadata.aptly.server.single``
+* ``metadata.aptly.client.publisher``
-``aptly.publisher``
--------------------
+This file provides the sample configurations for different use cases.
-Setup aptly publisher
+* Reclass examples:
-Available metadata
-==================
+ * The basic Aptly server configuration without repositories or mirrors:
-.. contents::
- :local:
+ .. code-block:: yaml
-``metadata.aptly.server.single``
---------------------------------
+ classes:
+ - service.aptly.server.single
+ parameters:
+ aptly:
+ server:
+ enabled: true
+ secure: true
+ gpg_keypair_id: A76882D3
+ gpg_passphrase:
+ gpg_public_key: |
+ -----BEGIN PGP PUBLIC KEY BLOCK-----
+ Version: GnuPG v1
+ ...
+ gpg_private_key: |
+ -----BEGIN PGP PRIVATE KEY BLOCK-----
+ Version: GnuPG v1
+ ...
-Setup basic server
+ * The definition of an s3 endpoint:
+
+ .. code-block:: yaml
+
+ parameters:
+ aptly:
+ server:
+ endpoint:
+ mys3endpoint:
+ engine: s3
+ awsAccessKeyID: xxxx
+ awsSecretAccessKey: xxxx
+ bucket: test
-``metadata.aptly.client.publisher``
------------------------------------
+* Pillar examples:
-Setup aptly publisher client
+ * The Aptly server basic configuration:
-Configuration parameters
-========================
+ .. code-block:: yaml
+
+ aptly:
+ server:
+ enabled: true
+ repo:
+ myrepo:
+ distribution: trusty
+ component: main
+ architectures: amd64
+ comment: "Custom components"
+ sources: false
+ publisher:
+ component: mycomponent
+ distributions:
+ - nightly/trusty
+
+ * The Aptly server mirrors configuration:
+
+ .. code-block:: yaml
+
+ aptly:
+ server:
+ mirror:
+ mirror_name:
+ source: http://example.com/debian
+ distribution: xenial
+ components: main
+ architectures: amd64
+ gpgkeys: 460F3999
+ filter: "!(Name (% *-dbg))"
+ filter_with_deps: true
+ publisher:
+ component: example
+ distributions:
+ - xenial/repo/nightly
+ - "s3:aptcdn:xenial/repo/nightly"
-Example reclass
-===============
+ * The definition of the proxy environment variables in cron job for
+ mirroring script:
-Basic Aptly server with no repos or mirrors.
+ .. code-block:: yaml
-.. code-block:: yaml
-
- classes:
- - service.aptly.server.single
- parameters:
- aptly:
- server:
- enabled: true
- secure: true
- gpg_keypair_id: A76882D3
- gpg_passphrase:
- gpg_public_key: |
- -----BEGIN PGP PUBLIC KEY BLOCK-----
- Version: GnuPG v1
- ...
- gpg_private_key: |
- -----BEGIN PGP PRIVATE KEY BLOCK-----
- Version: GnuPG v1
- ...
-
-Define s3 endpoint:
-
-.. code-block:: yaml
-
- parameters:
aptly:
server:
- endpoint:
- mys3endpoint:
- engine: s3
- awsAccessKeyID: xxxx
- awsSecretAccessKey: xxxx
- bucket: test
+ enabled: true
+ ...
+ mirror_update:
+ enabled: true
+ http_proxy: "http://1.2.3.4:8000"
+ https_proxy: "http://1.2.3.4:8000"
+ ...
-
-Example pillar
-==============
-
-.. code-block:: yaml
-
- aptly:
- server:
- enabled: true
- repo:
- myrepo:
- distribution: trusty
- component: main
- architectures: amd64
- comment: "Custom components"
- sources: false
- publisher:
- component: mycomponent
- distributions:
- - nightly/trusty
-
-Basic Aptly server mirrors
-
-.. code-block:: yaml
-
- aptly:
- server:
- mirror:
- mirror_name:
- source: http://example.com/debian
- distribution: xenial
- components: main
- architectures: amd64
- gpgkeys: 460F3999
- filter: "!(Name (% *-dbg))"
- filter_with_deps: true
- publisher:
- component: example
- distributions:
- - xenial/repo/nightly
- - "s3:aptcdn:xenial/repo/nightly"
-
-
-Proxy environment variables (optional) in cron job for mirroring script
-
-.. code-block:: yaml
-
- aptly:
- server:
- enabled: true
- ...
- mirror_update:
- enabled: true
- http_proxy: "http://1.2.3.4:8000"
- https_proxy: "http://1.2.3.4:8000"
- ...
-
-Read more
-=========
+**Read more**
* http://www.aptly.info/doc/configuration/
-Documentation and Bugs
-======================
+**Documentation and bugs**
-To learn how to install and update salt-formulas, consult the documentation
-available online at:
+* http://salt-formulas.readthedocs.io/
+ Learn how to install and update salt-formulas
- http://salt-formulas.readthedocs.io/
+* https://github.com/salt-formulas/salt-formula-ntp/issues
+ In the unfortunate event that bugs are discovered, report the issue to the
+ appropriate issue tracker. Use the Github issue tracker for a specific salt
+ formula
-In the unfortunate event that bugs are discovered, they should be reported to
-the appropriate issue tracker. Use Github issue tracker for specific salt
-formula:
+* https://launchpad.net/salt-formulas
+ For feature requests, bug reports, or blueprints affecting the entire
+ ecosystem, use the Launchpad salt-formulas project
- https://github.com/salt-formulas/salt-formula-aptly/issues
+* https://launchpad.net/~salt-formulas-users
+ Join the salt-formulas-users team and subscribe to mailing list if required
-For feature requests, bug reports or blueprints affecting entire ecosystem,
-use Launchpad salt-formulas project:
+* https://github.com/salt-formulas/salt-formula-aptly
+ Develop the salt-formulas projects in the master branch and then submit pull
+ requests against a specific formula
- https://launchpad.net/salt-formulas
-
-You can also join salt-formulas-users team and subscribe to mailing list:
-
- https://launchpad.net/~salt-formulas-users
-
-Developers wishing to work on the salt-formulas projects should always base
-their work on master branch and submit pull request against specific formula.
-
- https://github.com/salt-formulas/salt-formula-aptly
-
-Any questions or feedback is always welcome so feel free to join our IRC
-channel:
-
- #salt-formulas @ irc.freenode.net
+* #salt-formulas @ irc.freenode.net
+ Use this IRC channel in case of any questions or feedback which is always
+ welcome