From 8d4d3761d7549e4df2583bcf8f1ce460ffaf6dc5 Mon Sep 17 00:00:00 2001 From: Jedrzej Nowak Date: Mon, 21 Dec 2015 10:23:38 +0100 Subject: [PATCH] Resource Repository Docs added Change-Id: Ia055b9838d2311a70e6e4544bd672ce118f9efd8 --- doc/source/index.rst | 1 + doc/source/resource_repository.rst | 41 ++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 doc/source/resource_repository.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index a47361b5..06974403 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,6 +13,7 @@ Contents: glossary resource + resource_repository orchestration transports handler_ansible diff --git a/doc/source/resource_repository.rst b/doc/source/resource_repository.rst new file mode 100644 index 00000000..6a644b5e --- /dev/null +++ b/doc/source/resource_repository.rst @@ -0,0 +1,41 @@ +.. _resource_repository_details: + +Resource Repository +=================== + +Resource Repository takes care about :ref:`resource_details` definitions and it supports versioning. + +Solar CLI supports following options:: + + add Adds new resource to repository + contains Checks if `spec` is in Solar repositories + destroy Destroys repository + import Imports repository to Solar + remove Removes `spec` from Solar repositories + show Shows all added repositories, or content of repository when `-r` given + update Updates existing repository with new content + + + +Resource Repository spec +------------------------ + +`spec` is in format `{repository_name}/{resource_name}:{version_info}`, `version_info` is optional if omitted, latest (highest) will be used. +Versions are in `Semantic Versioning ` format. +You can also use `>`, `>=`, `==`, `<`, `<=` operators to specify matches. + + +Resource Repository import +-------------------------- + +Command `solar repository import` it allows you to import existing repository or directory with resources into your system. It will traverse `source` path copy all resources definitions into repository and obviously proper structure will be automatically created. + +.. note:: + You may also check `--link` option to this command. It will just link repository contents + so to import you need to have proper structure before. + + +Resource Repository update +-------------------------- + +Command `solar repository update` will update repository content with new data. With `--overwrite` flag it will overwrite conflicting resources definitions.