Update readme files for cloud
authorJee Hyeok Kim <jihyeok13.kim@samsung.com>
Wed, 24 Aug 2016 05:34:23 +0000 (14:34 +0900)
committerJee Hyeok Kim <jihyeok13.kim@samsung.com>
Wed, 24 Aug 2016 13:20:48 +0000 (13:20 +0000)
1. Update readme files for cloud
   (CI, RD, AS, MQ)

2. Update readme file for sample client

Change-Id: I3459192c3d43d4a3e6621980b881ac5e7876ce68
Signed-off-by: Jee Hyeok Kim <jihyeok13.kim@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/10855
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
cloud/account/README
cloud/interface/README
cloud/messagequeue/README [new file with mode: 0644]
cloud/messagequeue/server.properties [new file with mode: 0644]
cloud/resourcedirectory/README
cloud/samples/client/README

index 08ac84c..37d1215 100644 (file)
@@ -21,9 +21,13 @@ Build and Run
 4) Run .jar file
 
        go to "target" folder
-       $ java -jar CloudAccount-0.0.1-SNAPSHOT.jar arg1(AccountServer CoAP Server Port)
-       e.g. java -jar CloudAccount-0.0.1-SNAPSHOT.jar 5685
+       $ java -jar CloudAccount-0.0.1-SNAPSHOT.jar arg1(AccountServer CoAP Server Port) arg2(TLS mode required)
+       e.g. java -jar CloudAccount-0.0.1-SNAPSHOT.jar 5685 0
 
+        - If you want to operate on TLS mode, "CLOUD_CERT_FILE(iotivitycloud.crt)" and "CLOUD_KEY_FILE(iotivitycloud.key)" files
+          should be placed in the "target" folder.
+        - If you want to provide a certificate of another server in the payload of a sign-up response (when the certificate is
+          needed for a client to connect to the server), a "ROOT_CERT_FILE(rootca.crt)" file should be placed in the "target" folder.
        - Before you run a Accout server, You need to set up following steps.
           1) Install MongoDB
           2) Install Github certificates for github.com and *.github.com.
index 0ff3f64..d0edf41 100644 (file)
@@ -20,7 +20,8 @@ Build and Run
 4) Run .jar file
 
        go to "target" folder
-       $ java -jar CloudInterface-0.0.1-SNAPSHOT.jar arg1(CI CoAP Server Port) arg2(RD CoAP Server IP) arg3(RD CoAP Server Port) arg4(Account Server IP) arg5(Account Server Port)
-       e.g. java -jar CloudInterface-0.0.1-SNAPSHOT.jar 5683 127.0.0.1 5684 127.0.0.1 5685
+       $ java -jar CloudInterface-0.0.1-SNAPSHOT.jar arg1(CI CoAP Server Port) arg2(RD CoAP Server IP) arg3(RD CoAP Server Port) arg4(Account Server IP) arg5(Account Server Port) arg6(MQBroker IP) arg7(MQBroker Port) arg8(TLS mode required)
+       e.g. java -jar CloudInterface-0.0.1-SNAPSHOT.jar 5683 127.0.0.1 5684 127.0.0.1 5685 127.0.0.1 5686 0
 
-       - Before running a CI server, you should run a RD server and a Acccount server first.
+       - Before running a CI server, you should run a RD server, Account server and MQBroker first.
+       - If you want to operate on TLS mode, "CLOUD_CERT_FILE(iotivitycloud.crt)", "CLOUD_KEY_FILE(iotivitycloud.key)" and ROOT_CERT_FILE(rootca.crt) files should be placed in the "target" folder.
diff --git a/cloud/messagequeue/README b/cloud/messagequeue/README
new file mode 100644 (file)
index 0000000..544133d
--- /dev/null
@@ -0,0 +1,38 @@
+This project contains the Message Queue(MQ) Broker code.
+
+Build and Run
+
+1) Install Apache Maven if you don't have it
+
+    http://maven.apache.org
+
+2) Install Apache Kafka if you don't have it
+
+    http://kafka.apache.org/downloads.html
+
+    Set 'host.name' in Kafka server configuration file to your ip address,
+      Run Zookeeper server and Kafka broker with the configuration file.
+
+3) Build a CloudStack. If you are building first time, then build the stack.
+
+    go to "stack" folder in root directory
+    $ mvn install -Dmaven.test.skip=true
+
+4) Build a .jar file
+
+    $ mvn install -Dmaven.test.skip=true
+
+    - The CloudMessageQueue-0.0.1-SNAPSHOT.jar file will be placed in the "target" folder
+
+5) Run .jar file
+
+    go to "target" folder
+    $ java -jar CloudMessageQueue-0.0.1-SNAPSHOT.jar arg1(MQ CoAP Server Port) 
+      arg2(Zookeeper server address) arg3(Zookeeper server port)
+      arg4(kafka server address) arg5(kafka server port) arg6(TLS mode required)
+
+    e.g java -jar CloudMessageQueue-0.0.1-SNAPSHOT.jar 5686 127.0.0.1 2181 127.0.0.1 9092 0
+
+    - Before running a MQ Broker, you should run Zookeeper server and Kafka broker first.
+    - If you want to operate on TLS mode, "CLOUD_CERT_FILE(iotivitycloud.crt)", "CLOUD_KEY_FILE(iotivitycloud.key)"
+      and ROOT_CERT_FILE(rootca.crt) files should be placed in the "target" folder.
\ No newline at end of file
diff --git a/cloud/messagequeue/server.properties b/cloud/messagequeue/server.properties
new file mode 100644 (file)
index 0000000..473a635
--- /dev/null
@@ -0,0 +1,136 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# see kafka.server.KafkaConfig for additional details and defaults
+
+############################# Server Basics #############################
+
+# The id of the broker. This must be set to a unique integer for each broker.
+broker.id=0
+
+offsets.topic.num.partitions=1
+
+delete.topic.enable=true
+
+controlled.shutdown.enable=true
+
+unclean.leader.election.enable=false
+
+zookeeper.sync.time.ms=1000
+
+offsets.topic.replication.factor=1
+
+############################# Socket Server Settings #############################
+
+listeners=PLAINTEXT://:9092
+
+# The port the socket server listens on
+port=9092
+
+# Hostname the broker will bind to. If not set, the server will bind to all interfaces
+host.name=localhost
+
+# Hostname the broker will advertise to producers and consumers. If not set, it uses the
+# value for "host.name" if configured.  Otherwise, it will use the value returned from
+# java.net.InetAddress.getCanonicalHostName().
+#advertised.host.name=<hostname routable by clients>
+
+# The port to publish to ZooKeeper for clients to use. If this is not set,
+# it will publish the same port that the broker binds to.
+#advertised.port=<port accessible by clients>
+
+# The number of threads handling network requests
+num.network.threads=10
+# The number of threads doing disk I/O
+num.io.threads=10
+
+# The send buffer (SO_SNDBUF) used by the socket server
+socket.send.buffer.bytes=102400000
+
+# The receive buffer (SO_RCVBUF) used by the socket server
+socket.receive.buffer.bytes=102400000
+
+# The maximum size of a request that the socket server will accept (protection against OOM)
+socket.request.max.bytes=1048576000
+
+queued.max.requests=100
+
+############################# Log Basics #############################
+
+# A comma seperated list of directories under which to store log files
+log.dirs=/tmp/kafka-logs
+
+# The default number of log partitions per topic. More partitions allow greater
+# parallelism for consumption, but this will also result in more files across
+# the brokers.
+num.partitions=1
+
+# The number of threads per data directory to be used for log recovery at startup and flushing at shutdown.
+# This value is recommended to be increased for installations with data dirs located in RAID array.
+num.recovery.threads.per.data.dir=1
+
+############################# Log Flush Policy #############################
+
+# Messages are immediately written to the filesystem but by default we only fsync() to sync
+# the OS cache lazily. The following configurations control the flush of data to disk. 
+# There are a few important trade-offs here:
+#    1. Durability: Unflushed data may be lost if you are not using replication.
+#    2. Latency: Very large flush intervals may lead to latency spikes when the flush does occur as there will be a lot of data to flush.
+#    3. Throughput: The flush is generally the most expensive operation, and a small flush interval may lead to exceessive seeks. 
+# The settings below allow one to configure the flush policy to flush data after a period of time or
+# every N messages (or both). This can be done globally and overridden on a per-topic basis.
+
+# The number of messages to accept before forcing a flush of data to disk
+#log.flush.interval.messages=10000
+
+# The maximum amount of time a message can sit in a log before we force a flush
+#log.flush.interval.ms=1000
+
+############################# Log Retention Policy #############################
+
+# The following configurations control the disposal of log segments. The policy can
+# be set to delete segments after a period of time, or after a given size has accumulated.
+# A segment will be deleted whenever *either* of these criteria are met. Deletion always happens
+# from the end of the log.
+
+# The minimum age of a log file to be eligible for deletion
+log.retention.hours=168
+
+# A size-based retention policy for logs. Segments are pruned from the log as long as the remaining
+# segments don't drop below log.retention.bytes.
+#log.retention.bytes=1073741824
+
+# The maximum size of a log segment file. When this size is reached a new log segment will be created.
+log.segment.bytes=1073741824
+
+# The interval at which log segments are checked to see if they can be deleted according 
+# to the retention policies
+log.retention.check.interval.ms=300000
+
+# By default the log cleaner is disabled and the log retention policy will default to just delete segments after their retention expires.
+# If log.cleaner.enable=true is set the cleaner will be enabled and individual logs can then be marked for log compaction.
+log.cleaner.enable=true
+
+############################# Zookeeper #############################
+
+# Zookeeper connection string (see zookeeper docs for details).
+# This is a comma separated host:port pairs, each corresponding to a zk
+# server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002".
+# You can also append an optional chroot string to the urls to specify the
+# root directory for all kafka znodes.
+zookeeper.connect=localhost:2181
+
+# Timeout in ms for connecting to zookeeper
+zookeeper.connection.timeout.ms=6000
index c283f66..20c3cb2 100644 (file)
@@ -24,6 +24,7 @@ Build and Run
 5) Run .jar file
 
        go to "target" folder
-       $ java -jar CloudResourceDirectory-0.0.1-SNAPSHOT.jar arg1(RD CoAP Server Port)
-       e.g java -jar CloudResourceDirectory-0.0.1-SNAPSHOT.jar 5684
+       $ java -jar CloudResourceDirectory-0.0.1-SNAPSHOT.jar arg1(RD CoAP Server Port) arg2(TLS mode required)
+       e.g java -jar CloudResourceDirectory-0.0.1-SNAPSHOT.jar 5684 0
 
+    - If you want to operate on TLS mode, "CLOUD_CERT_FILE(iotivitycloud.crt)", "CLOUD_KEY_FILE(iotivitycloud.key)" and ROOT_CERT_FILE(rootca.crt) files should be placed in the "target" folder.
\ No newline at end of file
index 5f6dbbb..734609f 100644 (file)
@@ -4,7 +4,7 @@ ex) scons WITH_TCP=yes TARGET_TRANSPORT=IP WITH_CLOUD=yes
 
 Cloud client runs using CoAP over TCP transport. So you should add WITH_TCP option.
 
-Once you get sample which file name is 'cloud_device', you need 'Auth Code' to register resources on cloud with account scenario.
+Once you get sample which file name is 'aircon_controlee' and 'aircon_controller', you need 'Auth Code' to register resources on cloud with account scenario.
 
 Cloud stack has sample github oauth2 adaptor.
 
@@ -20,6 +20,4 @@ http://www.example.com/oauth_callback/?code=bf9beb5db17ea476fa46
 
 You can get 'Auth Code', value of '?code' query string.
 
-The 'Auth Code' is one time token. So you need other token to run other device.
-
-Account server has pre-coded admin credential which session is '00000000'. You can use this credential for immediate tests.
\ No newline at end of file
+The 'Auth Code' is one time token. So you need other token to run each sample.
\ No newline at end of file