blob: 250ea826d481a6119981fb6c011f95ef0993a8a9 [file] [log] [blame]
Ales Komarekef982692016-02-21 14:56:07 +01001
2==================
smolaon552ba582016-02-23 20:35:42 +01003Metal as a Service
Ales Komarekef982692016-02-21 14:56:07 +01004==================
5
6Service maas description
7
8Sample pillars
9==============
10
11Single maas service
12
13.. code-block:: yaml
14
15 maas:
16 server:
17 enabled: true
18
Ondrej Smola9af2b082016-08-25 17:37:29 +020019Single MAAS region service [single UI/API]
20
21.. code-block:: yaml
22
Damian Szelugaa8248102017-03-16 08:48:51 +010023 maas:
Damian Szeluga336ff2e2017-03-30 11:19:34 +020024 salt_master_ip: 192.168.0.10
Damian Szelugaa8248102017-03-16 08:48:51 +010025 region:
26 theme: mirantis
27 bind:
28 host: 192.168.0.10:5240
29 port: 5240
30 admin:
31 username: exampleuser
32 password: examplepassword
33 email: email@example.com
34 database:
35 engine: null
36 host: localhost
37 name: maasdb
38 password: qwqwqw
39 username: maas
40 enabled: true
41 user: mirantis
42 token: "89EgtWkX45ddjMYpuL:SqVjxFG87Dr6kVf4Wp:5WLfbUgmm9XQtJxm3V2LUUy7bpCmqmnk"
43 fabrics:
44 test-fabric:
45 description: Test fabric
46 subnets:
47 subnet1:
48 fabric: test-fabric
49 cidr: 2.2.3.0/24
50 gateway_ip: 2.2.3.2
51 iprange:
52 start: 2.2.3.20
53 end: 2.2.3.250
54 dhcp_snippets:
55 test-snippet:
56 value: option bootfile-name "tftp://192.168.0.10/snippet";
57 description: Test snippet
58 enabled: true
59 subnet: subnet1
60 boot_resources:
61 bootscript1:
62 title: bootscript
63 architecture: amd64/generic
64 filetype: tgz
65 content: /srv/salt/reclass/nodes/path_to_file
66 package_repositories:
67 Saltstack:
68 url: http://repo.saltstack.com/apt/ubuntu/14.04/amd64/2016.3/
69 distributions:
70 - trusty
71 components:
72 - main
Damian Szelugaa8248102017-03-16 08:48:51 +010073 arches: amd64
74 key: "-----BEGIN PGP PUBLIC KEY BLOCK-----
75 Version: GnuPG v2
Pavel Cizinsky5a6e2722016-08-31 15:58:13 +020076
Damian Szelugaa8248102017-03-16 08:48:51 +010077 mQENBFOpvpgBCADkP656H41i8fpplEEB8IeLhugyC2rTEwwSclb8tQNYtUiGdna9
78 m38kb0OS2DDrEdtdQb2hWCnswxaAkUunb2qq18vd3dBvlnI+C4/xu5ksZZkRj+fW
79 tArNR18V+2jkwcG26m8AxIrT+m4M6/bgnSfHTBtT5adNfVcTHqiT1JtCbQcXmwVw
80 WbqS6v/LhcsBE//SHne4uBCK/GHxZHhQ5jz5h+3vWeV4gvxS3Xu6v1IlIpLDwUts
81 kT1DumfynYnnZmWTGc6SYyIFXTPJLtnoWDb9OBdWgZxXfHEcBsKGha+bXO+m2tHA
82 gNneN9i5f8oNxo5njrL8jkCckOpNpng18BKXABEBAAG0MlNhbHRTdGFjayBQYWNr
83 YWdpbmcgVGVhbSA8cGFja2FnaW5nQHNhbHRzdGFjay5jb20+iQE4BBMBAgAiBQJT
84 qb6YAhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRAOCKFJ3le/vhkqB/0Q
85 WzELZf4d87WApzolLG+zpsJKtt/ueXL1W1KA7JILhXB1uyvVORt8uA9FjmE083o1
86 yE66wCya7V8hjNn2lkLXboOUd1UTErlRg1GYbIt++VPscTxHxwpjDGxDB1/fiX2o
87 nK5SEpuj4IeIPJVE/uLNAwZyfX8DArLVJ5h8lknwiHlQLGlnOu9ulEAejwAKt9CU
88 4oYTszYM4xrbtjB/fR+mPnYh2fBoQO4d/NQiejIEyd9IEEMd/03AJQBuMux62tjA
89 /NwvQ9eqNgLw9NisFNHRWtP4jhAOsshv1WW+zPzu3ozoO+lLHixUIz7fqRk38q8Q
90 9oNR31KvrkSNrFbA3D89uQENBFOpvpgBCADJ79iH10AfAfpTBEQwa6vzUI3Eltqb
91 9aZ0xbZV8V/8pnuU7rqM7Z+nJgldibFk4gFG2bHCG1C5aEH/FmcOMvTKDhJSFQUx
92 uhgxttMArXm2c22OSy1hpsnVG68G32Nag/QFEJ++3hNnbyGZpHnPiYgej3FrerQJ
93 zv456wIsxRDMvJ1NZQB3twoCqwapC6FJE2hukSdWB5yCYpWlZJXBKzlYz/gwD/Fr
94 GL578WrLhKw3UvnJmlpqQaDKwmV2s7MsoZogC6wkHE92kGPG2GmoRD3ALjmCvN1E
95 PsIsQGnwpcXsRpYVCoW7e2nW4wUf7IkFZ94yOCmUq6WreWI4NggRcFC5ABEBAAGJ
96 AR8EGAECAAkFAlOpvpgCGwwACgkQDgihSd5Xv74/NggA08kEdBkiWWwJZUZEy7cK
97 WWcgjnRuOHd4rPeT+vQbOWGu6x4bxuVf9aTiYkf7ZjVF2lPn97EXOEGFWPZeZbH4
98 vdRFH9jMtP+rrLt6+3c9j0M8SIJYwBL1+CNpEC/BuHj/Ra/cmnG5ZNhYebm76h5f
99 T9iPW9fFww36FzFka4VPlvA4oB7ebBtquFg3sdQNU/MmTVV4jPFWXxh4oRDDR+8N
100 1bcPnbB11b5ary99F/mqr7RgQ+YFF0uKRE3SKa7a+6cIuHEZ7Za+zhPaQlzAOZlx
101 fuBmScum8uQTrEF5+Um5zkwC7EXTdH1co/+/V/fpOtxIg4XO4kcugZefVm5ERfVS
102 MA==
103 =dtMN
104 -----END PGP PUBLIC KEY BLOCK-----"
105 enabled: true
106 machines:
107 machine1:
108 interfaces:
Maciej Relewicz37b12a22017-04-25 15:23:16 +0200109 mac: "11:22:33:44:55:66"
Damian Szelugaa8248102017-03-16 08:48:51 +0100110 power_parameters:
111 power_type: ipmi
112 power_address: '192.168.10.10'
113 power_user: bmc_user
114 power_password: bmc_password
Ondrej Smola455003c2017-06-01 22:53:39 +0200115 #Optional (for legacy HW)
116 power_driver: LAN
Maciej Relewicz37b12a22017-04-25 15:23:16 +0200117 distro_series: xenial
118 hwe_kernel: hwe-16.04
Damian Szelugaa8248102017-03-16 08:48:51 +0100119 devices:
120 machine1-ipmi:
121 interface:
122 ip_address: 192.168.10.10
123 subnet: cidr:192.168.10.0/24
124 mac: '66:55:44:33:22:11'
Damian Szeluga336ff2e2017-03-30 11:19:34 +0200125 commissioning_scripts:
126 00-maas-06-create-raid.sh: /srv/salt/reclass/scripts/commisioning_script.sh
127 maas_config:
128 domain: mydomain.local
129 http_proxy: http://192.168.0.10:3142
130 commissioning_distro_series: xenial
131 default_distro_series: xenial
132 default_osystem: 'ubuntu'
133 default_storage_layout: lvm
134 disk_erase_with_secure_erase: true
135 dnssec_validation: 'no'
136 enable_third_party_drivers: true
137 maas_name: cfg01
138 network_discovery: 'enabled'
139 active_discovery_interval: '600'
140 ntp_external_only: true
141 ntp_servers: 10.10.11.23 10.10.11.24
142 upstream_dns: 192.168.12.13
143 enable_http_proxy: true
144 default_min_hwe_kernel: ''
145 sshprefs:
146 - 'ssh-rsa ASDFOSADFISdfasdfasjdklfjasdJFASDJfASdf923@AAAAB3NzaC1yc2EAAAADAQABAAACAQCv8ISOESGgYUOycYw1SAs/SfHTqtSCTephD/7o2+mEZO53xN98sChiFscFaPA2ZSMoZbJ6MQLKcWKMK2OaTdNSAvn4UE4T6VP0ccdumHDNRwO3f6LptvXr9NR5Wocz2KAgptk+uaA8ytM0Aj9NT0UlfjAXkKnoKyNq6yG+lx4HpwolVaFSlqRXf/iuHpCrspv/u1NW7ReMElJoXv+0zZ7Ow0ZylISdYkaqbV8QatCb17v1+xX03xLsZigfugce/8CDsibSYvJv+Hli5CCBsKgfFqLy4R5vGxiLSVzG/asdjalskjdlkasjdasd/asdajsdkjalaksdjfasd/fa/sdf/asd/fas/dfsadf blah@blah'
Ondrej Smola9af2b082016-08-25 17:37:29 +0200147
148
149Single MAAS cluster service [multiple racks]
150
151.. code-block:: yaml
152
153 maas:
154 cluster:
155 enabled: true
Jakub Pavlikf43512b2016-08-30 10:25:42 +0200156 role: master/slave
Ondrej Smola9af2b082016-08-25 17:37:29 +0200157
Ales Komarekef982692016-02-21 14:56:07 +0100158Read more
159=========
160
161*
Filip Pytlounc07d2352017-02-02 13:02:03 +0100162
163Documentation and Bugs
164======================
165
166To learn how to install and update salt-formulas, consult the documentation
167available online at:
168
169 http://salt-formulas.readthedocs.io/
170
171In the unfortunate event that bugs are discovered, they should be reported to
172the appropriate issue tracker. Use Github issue tracker for specific salt
173formula:
174
175 https://github.com/salt-formulas/salt-formula-maas/issues
176
177For feature requests, bug reports or blueprints affecting entire ecosystem,
178use Launchpad salt-formulas project:
179
180 https://launchpad.net/salt-formulas
181
182You can also join salt-formulas-users team and subscribe to mailing list:
183
184 https://launchpad.net/~salt-formulas-users
185
186Developers wishing to work on the salt-formulas projects should always base
187their work on master branch and submit pull request against specific formula.
188
189 https://github.com/salt-formulas/salt-formula-maas
190
191Any questions or feedback is always welcome so feel free to join our IRC
192channel:
193
194 #salt-formulas @ irc.freenode.net