x/solar
Code Issues Proposed changes

Resource Repository Docs added

Browse Source 
Change-Id: Ia055b9838d2311a70e6e4544bd672ce118f9efd8
This commit is contained in:
Jedrzej Nowak 2015-12-21 10:23:38 +01:00
parent 8f63ec03f2
commit 8d4d3761d7
2 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/index.rst
View File

@ -13,6 +13,7 @@ Contents:
glossary
resource
resource_repository
orchestration
transports
handler_ansible

41
doc/source/resource_repository.rst Normal file
View File

@ -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 <http://semver.org/>` 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.