diff options
Diffstat (limited to 'docs/multi.rst')
| -rw-r--r-- | docs/multi.rst | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/docs/multi.rst b/docs/multi.rst new file mode 100644 index 00000000..bc26465f --- /dev/null +++ b/docs/multi.rst @@ -0,0 +1,181 @@ +=========================== +Multi-site or Local Cluster +=========================== +Follow the instructions for local MUSIC installation on all the machines/VMs/hosts (referred to as a node) on which you want MUSIC installed. However, Cassandra and Zookeeper needs to be configured to run as multi-node installations (instructions below) before running them. + +Cassandra: +---------- +In the cassandra.yaml file which is present in the cassa_install/conf directory in each node, set the following parameters: +cassandra.yaml:: + + cluster_name: ‘name of cluster’ + #... + num_tokens: 256 + #... + seed_provider: + - class_name: org.apache.cassandra.locator.SimpleSeedProvider + parameters: + - seeds: "<public ip of first seed>, <public ip of second seed>, etc" + #... + listen_address: private ip of VM + #... + broadcast_address: public ip of VM + #... + endpoint_snitch: GossipingPropertyFileSnitch + #... + rpc_address: <private ip> + #... + phi_convict_threshold: 12 + +- In the cassandra-rackdc.properties file, assign data center and rack names as needed if required ( This is for multi data center install). +- Once this is done on all three nodes, you can run cassandra on each of the nodes through the cassandra bin folder with this command:: + + ./cassandra + +- In the cassandra bin folder, if you run the following it will tell you the state of the cluster:: + + ./nodetool status + +- To access cassandra, one any of the nodes you can run the following and then perform CQL queries.:: + + ./cqlsh <private ip> + +Extra Cassandra information for Authentication: +----------------------------------------------- +To create first user in Cassandra + +1. Edit conf/Cassandra.yaml file:: + + authenticator: PasswordAuthenticator + authorizer: CassandraAuthorizer + + +2. Restart Cassandra +3. Login to cqlsh with default credentials:: + + cqlsh -u cassandra -p cassandra + +4. To change default user create new user with the following command.:: + + CREATE USER new_user WITH PASSWORD ‘new_password’ SUPERUSER; + +5. Change password for default user ‘Cassandra’ so that no one will be able to login:: + + ALTER USER cassandra WITH PASSWORD ‘SomeLongRandomStringNoonewillthinkof’; + +6. Provide the new user credentials to Music. Update music.properties file and uncomment or add the following:: + + cassandra.user=<new_user> + cassandra.password=<new_password> + +To access keyspace through cqlsh, login with credentials that are passed to MUSIC while creating the keyspace. + + + +Zookeeper: +---------- +Once zookeeper has been installed on all the nodes, modify the **zk_install_location/conf/zoo.cfg** on all the nodes with the following lines: + +:: + + tickTime=2000 + dataDir=/opt/app/music/var/zookeeper + clientPort=2181 + initLimit=5 + syncLimit=2 + quorumListenOnAllIPs=true + server.1=public IP of node 1:2888:3888 + server.2=public IP of node 2:2888:3888 + server.3=public IP of node 3:2888:3888 + +Create the directory /var/zookeeper in all the machines and within that create a file called myid that contains the id of the machine. The machine running node.i will contain just the number i in the file myid. + +Start each of the nodes one by one from the zk_install_location/bin folder using the command: + + + + ./zkServer.sh start + +On each node check the file zookeeper.out in the zk_install_location/ bin to make sure all the machines are talking to each other and there are no errors. Note that while the machines are yet to come up there maybe error messages saying that connection has not yet been established. Clearly, this is ok. + + +If there are no errors, then from zk_install_location/bin simply run the following to get command line access to zookeeper. ./zkCli.sh + + +Run these commands on different machines to make sure the zk nodes are syncing. + +:: + + [zkshell] ls / + [zookeeper] + +Next, create a new znode by running + +:: + + create /zk_test my_data. + +This creates a new znode and associates the string "my_data" with the node. You should see: + +:: + + [zkshell] create /zk_test my_data + Created /zk_test + +Issue another ls / command to see what the directory looks like: + +:: + + [zkshell] ls / + [zookeeper, zk_test] + +MUSIC +Create a music.properties file and place it in /opt/app/music/etc at each node. Here is a sample of the file: +cassandra.yaml:: + + my.id=0 + all.ids=0 + my.public.ip=localhost + all.public.ips=localhost + ####################################### + # Optional current values are defaults + ####################################### + # If using docker this would point to the specific docker name. + #zookeeper.host=localhost + #cassandra.host=localhost + #music.ip=localhost + #debug=true + #music.rest.ip=localhost + #lock.lease.period=6000 + # Cassandra Login - Do not user cassandra/cassandra + cassandra.user=cassandra1 + cassandra.password=cassandra1 + # AAF Endpoint + #aaf.endpoint.url=<aaf url> + +- Build the MUSIC.war (see `Build Music`_) and place it within the webapps folder of the tomcat installation. +- Start tomcat and you should now have MUSIC running. + +For Logging create a dir /opt/app/music/logs. When MUSIC/Tomcat starts a MUSIC dir with various logs will be created. + +Build Music +^^^^^^^^^^^ +Documentation will be updated to show that. Code can be downloaded from Music Gerrit. +To build you will need to ensure you update your settings with the ONAP settings.xml +(Workspace and Development Tools) + +Once you have done that run the following: + +:: + + # If you installed settings.xml in your ./m2 folder + mvn clean package + # If you placed the settings.xml elsewhere: + mvn clean package -s /path/to/settings.xml + +After it is built you will find the MUSIC.war in the ./target folder. + +There is a folder called postman that contains a postman collection for testing with postman. + +Continue with `Authentication <./automation.rst>`_ +
\ No newline at end of file |