Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / artifactory / 8a0ac266b917ea8c3ba7eab0395fea0fc0aa6f42 / . / README.rst
blob: 60ac3ec86f78c6661164d63ad68f297852221857 [file] [log] [blame]
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]1
Ales Komarek70fdd162016-08-19 12:28:05 +0200[diff] [blame]2===========
3Artifactory
4===========
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]5
Ales Komarek70fdd162016-08-19 12:28:05 +0200[diff] [blame]6JFrog Artifactory is the only Universal Repository Manager supporting all major packaging formats, build tools and CI servers.
7
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]8
9Sample pillars
10==============
11
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]12Server
13------
14
Ales Komarek70fdd162016-08-19 12:28:05 +0200[diff] [blame]15Single artifactory OSS edition from OS package
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]16
17.. code-block:: yaml
18
19 artifactory:
20 server:
21 enabled: true
Ales Komarek70fdd162016-08-19 12:28:05 +0200[diff] [blame]22 edition: oss
23 version: 4
24 source:
25 engine: pkg
26
27Single artifactory pro edition from OS package
28
29.. code-block:: yaml
30
31 artifactory:
32 server:
33 enabled: true
34 edition: pro
35 version: 4
36 source:
37 engine: pkg
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]38
Ales Komarek441ba232016-08-19 14:00:27 +0200[diff] [blame]39Single artifactory with PostgreSQL database
40
41.. code-block:: yaml
42
43 artifactory:
44 server:
45 database:
46 engine: postgresql
47 host: localhost
48 port: 5432
49 name: artifactory
50 user: artifactory
51 password: pass
52
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]53Client
54------
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]55
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]56Basic client setup
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]57
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]58.. code-block:: yaml
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]59
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]60 artifactory:
61 client:
62 enabled: true
63 server:
64 host: 10.10.10.148
65 port: 8081
66 user: admin
67 password: password
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]68
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]69Artifactory repository definition
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]70
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]71.. code-block:: yaml
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]72
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]73 artifactory:
74 client:
75 enabled: true
76 repo:
77 local_artifactory_repo:
78 name: local_artifactory_repo
79 package_type: docker
80 repo_type: local
81 remote_artifactory_repo:
82 name: remote_artifactory_repo
83 package_type: generic
84 repo_type: remote
85 url: "http://totheremoterepo:80/"
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]86
Alexander Evseev81494492017-09-14 20:42:08 +0300[diff] [blame]87
88Repository configuration
89========================
90
91Sample pillar above shows basic repository configuration, but you can use any parameters
92described in https://www.jfrog.com/confluence/display/RTF/Repository+Configuration+JSON
93
94This module does direct map from pillar parameters to repository JSON description
95with two aliases for compatibility:
96
97 * repo_type -> rclass
98 * package_type -> packageType
99
100
Ales Komarekf9d35ae2016-08-19 10:23:00 +0200[diff] [blame]101Read more
102=========
103
Ales Komarek70fdd162016-08-19 12:28:05 +0200[diff] [blame]104* https://www.jfrog.com/confluence/display/RTF/Debian+Repositories
Ales Komarek197f4432016-09-02 15:26:17 +0200[diff] [blame]105* https://www.jfrog.com/confluence/display/RTF/PostgreSQL
106* https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-REPOSITORIES
Filip Pytlouna1a846d2017-02-02 13:02:03 +0100[diff] [blame]107* https://www.jfrog.com/confluence/display/RTF/Repository+Configuration+JSON
Alexander Evseev81494492017-09-14 20:42:08 +0300[diff] [blame]108
Filip Pytlouna1a846d2017-02-02 13:02:03 +0100[diff] [blame]109Documentation and Bugs
110======================
111
112To learn how to install and update salt-formulas, consult the documentation
113available online at:
114
115 http://salt-formulas.readthedocs.io/
116
117In the unfortunate event that bugs are discovered, they should be reported to
118the appropriate issue tracker. Use Github issue tracker for specific salt
119formula:
120
121 https://github.com/salt-formulas/salt-formula-artifactory/issues
122
123For feature requests, bug reports or blueprints affecting entire ecosystem,
124use Launchpad salt-formulas project:
125
126 https://launchpad.net/salt-formulas
127
128You can also join salt-formulas-users team and subscribe to mailing list:
129
130 https://launchpad.net/~salt-formulas-users
131
132Developers wishing to work on the salt-formulas projects should always base
133their work on master branch and submit pull request against specific formula.
134
135 https://github.com/salt-formulas/salt-formula-artifactory
136
137Any questions or feedback is always welcome so feel free to join our IRC
138channel:
139
140 #salt-formulas @ irc.freenode.net