Update README.md with Red Hat linux family install instructions

8b0376e0 · Czémán Arnold · df20b936 · 8b0376e0
Commit 8b0376e0 authored Jul 27, 2015 by Czémán Arnold
Hide whitespace changes
Inline Side-by-side

Showing with 99 additions and 66 deletions

README.md
+99 -66

No files found.
--- a/README.md
+++ b/README.md
-# Circle Project for Cent OS 7 - Salt Installer
+# Circle Project - Salt Installer
+## OS Support
+* Red Hat Linux family:
+    * Red Hat Enterprise Linux 7+ --> work in progress
+    * Cent OS 7+
+    * Scientific Linux 7+ --> work in progress
+* Debian Linux family:
+    * Debian linux 8+ --> work in progress
+    * Ubuntu linux 14.04 LTS
+    * Ubuntu linux 15.04+ --> work in progress
+## Prerequisites
+### Red Hat family
+Install EPEL repository (if the link is broken, please contact us):
+```bash
+sudo rpm -ivh http://dl.fedoraproject.org/pub/epel/7/x86_64/e/epel-release-7-5.noarch.rpm
+```
+Install some important packages:
+```bash
+sudo yum install python-pip gcc vim git
+```
+### Debian family
+Install some important packages:
+```bash
+sudo apt-get install python-pip git
+```
 ## Install Salt
 ```bash
-sudo add-apt-repository ppa:saltstack/salt
+sudo pip install salt==2014.7.1
-sudo apt-get update
-sudo apt-get install salt-minion
 ```
 ## Configure salt
 Open the salt minion configuration
 ```bash
+sudo mkdir /etc/salt
 sudo vim /etc/salt/minion
 ```
@@ -37,83 +69,75 @@ git clone https://git.ik.bme.hu/circle/salt.git
 ## Change variables
 Modify installer.sls file
 ```
 sudo vim salt/pillar/installer.sls
 ```
 Most used variables
 -------------------
-* user: user who will install the software
+* **proxy_secret**: This is used to provide cryptographic signing, and should be set to a unique, unpredictable value.
-* proxy_secret: proxy secret key TODO
+* **secret_key**: This is used to provide cryptographic signing, and should be set to a unique, unpredictable value.
-* secret_key: secret key TODO
+* **deployment_type**: local (development) or production
-* time zone: the server's time zone, format is region/city
-* deployment_type: local or ? TODO
 * **admin_user**: user name to login in as admin on the site
 * **admin_pass**: password to login in as admin on the site
-* database:
+* **database**:
-   * name: django database's name
+    * **password**: database user’s password
-   * user: database user
+* **amqp**:
-   * password: database user's password
+    * **password**: ampq user’s password
-* amqp:
+    * **host**: amqp server IP - usually runs at localhost
-   * user: amqp user
+* **graphite**:
-   * password: ampq user's password
+    * **password**: graphite user’s password
-   * host: amqp server IP - usually runs at localhost
+    * **host**: graphite server IP - usually runs at localhost
-   * port: amqp server's port
+* **nfs**:
-   * vhost: virtual host - specifies the namespace for entities (exchanges and queues) referred to by the protocol
+    * **enabled**: nfs is enabled
-* graphite:
+    * **server**: nfs server’s hostname
-   * user: graphite user
+    * **network**: nfs server’s network to access files
-   * password: graphite user's password
+    * **directory**: this directory will be shared
-   * host: graphite server IP - usually runs at localhost
+* **storagedriver**:
-   * port: graphite server's port
+    * **queue_name**: the server’s hostname
-   * vhost: TODO
+* **fwdriver**:
-   * queue: TODO
+    * **queue_name**: the server’s hostname
-   * secret_key: graphite's secret key
+    * **gateway**: the server’s gateway
-* cache: cache url - usually pylibmc://127.0.0.1:11211/
+    * **external_net**: the server’s network
-* nfs:
+    * **external_if**: the server’s network interface
-   * enabled: nfs is enabled
-   * server: nfs server's hostname
-   * network: nfs server's network to access files
-   * directory: this directory will be shared
-* storagedriver:
-   * queue_name: TODO
-* fwdriver:
-   * queue_name: the server's hostname
-   * gateway: the server's gateway
-   * EXTERNAL_Net: the server's network
-   * external_if: the server's network interface
-   * trunk_if: trunk interface TODO
-   * management_if: TODO
 Other variables
 ---------------
+* user: user who will install the software
+* time zone: the server’s time zone, format is region/city
+* amqp:
+    * user: amqp user
+    * port: amqp server’s port
+    * vhost: virtual host - specifies the namespace for entities (exchanges and queues) referred to by the protocol
 * agent:
-   * repo_name: the agent repository's name
+    * repo_revision: revision
-   * repo_revision: revision
 * agentdriver:
-   * repo_name: the agentdriver repository's name
+    * repo_revision: revision
-   * repo_revision: revision
+* cache: cache url - usually pylibmc://127.0.0.1:11211/
+* database:
+    * name: django database’s name
+    * user: database user
 * fwdriver:
-   * repo_name: the fwdriver repository's name
+    * repo_revision: revision
-   * repo_revision: revision
+    * user: fwdriver user name
-   * user: fwdriver user name
+    * vm_if: vm interface
-   * vm_if: vm interface
+    * vm_et: vm network
-   * vm_et: vm network
+    * management_if: management interface
+* graphite:
+    * user: graphite user
+    * port: graphite server’s port
+    * secret_key: graphite’s secret key
 * manager:
-   * repo_name: the manager repository's name
+    * repo_revision: revision
-   * repo_revision: revision
 * monitor-client:
-   * repo_name: the monitor-client repository's name
+    * repo_revision: revision
-   * repo_revision: revision
 * storage-driver:
-   * repo_name: the storage-driver repository's name
+    * repo_revision: revision
-   * repo_revision: revision
 * vm-driver:
-   * repo_name: the vm-driver repository's name
+    * repo_revision: revision
-   * repo_revision: revision
 * vnc-driver:
-   * repo_name: the vnc-driver repository's name
+    * repo_revision: revision
-   * repo_revision: revision
 ## Install Circle
 Run the following installation command:
@@ -121,11 +145,18 @@ Run the following installation command:
 ```bash
 sudo salt-call state.sls allinone
 ```
+After this finished, you have to get "Failed: 0" message.
+If installer fails, please visit the [Troubleshooting](#troubleshooting) paragraph.
-After install, delete agent.conf file:
+After install, delete agent.conf or agent.service file:
+If you have upstart:
 ```bash
-sudo rm /etc/init/agent.conf
+sudo rm -f /etc/init/agent.conf
+```
+Or if you have systemd:
+```bash
+sudo rm -f /etc/systemd/system/agent.service
 ```
 ## Quickstart - Standalone Node
@@ -170,4 +201,7 @@ To install an OS, we can use ISO images, to boot from. Click on 'download disk' 
 ### Start Virtual Machine
 Finally, we can run the machine. Click on 'deploy' and start it. You can choose, on which node do you want to run.
 ![ubuntu 14.04](_static/images/ubuntu.png)
\ No newline at end of file
+## Troubleshooting ##
+Comming soon!