From 38d71dbd7edeeb9e38c333bce74f4a0e697008f6 Mon Sep 17 00:00:00 2001
From: Sergey Yakubov <sergey.yakubov@desy.de>
Date: Thu, 1 Apr 2021 11:19:34 +0200
Subject: [PATCH] update docs
---
CMakeModules/prepare_version_tag.cmake | 5 ++
VERSIONS.md | 2 +-
.../getting_started/install_cpp_clients.sh | 8 ++++
.../install_python_clients_pip.sh | 12 +++++
.../install_python_clients_pkg.sh | 8 ++++
...apo_container.sh => start_asapo_socket.sh} | 1 +
.../getting_started/start_asapo_tcp.sh | 47 +++++++++++++++++++
7 files changed, 82 insertions(+), 1 deletion(-)
create mode 100644 examples/for_site/getting_started/install_cpp_clients.sh
create mode 100644 examples/for_site/getting_started/install_python_clients_pip.sh
create mode 100644 examples/for_site/getting_started/install_python_clients_pkg.sh
rename examples/for_site/getting_started/{start_asapo_container.sh => start_asapo_socket.sh} (98%)
create mode 100644 examples/for_site/getting_started/start_asapo_tcp.sh
diff --git a/CMakeModules/prepare_version_tag.cmake b/CMakeModules/prepare_version_tag.cmake
index 35273cb25..143d4df5a 100644
--- a/CMakeModules/prepare_version_tag.cmake
+++ b/CMakeModules/prepare_version_tag.cmake
@@ -24,6 +24,10 @@ if (${BRANCH} STREQUAL "master")
SET (ASAPO_VERSION_COMMIT "")
SET (ASAPO_VERSION_DOCKER_SUFFIX "")
SET (PYTHON_ASAPO_VERSION ${ASAPO_VERSION})
+ SET (ASAPO_VERSION "20.01.1")
+ string(REGEX REPLACE "\\.0([0-9]+)\\."
+ ".\\1." ASAPO_WHEEL_VERSION
+ ${ASAPO_VERSION})
else()
SET (ASAPO_VERSION ${BRANCH})
SET (ASAPO_VERSION_COMMIT ", build ${ASAPO_VERSION_COMMIT}")
@@ -31,6 +35,7 @@ else()
string(REPLACE "_" "-" ASAPO_VERSION ${ASAPO_VERSION})
SET (ASAPO_VERSION 1.0.${ASAPO_VERSION})
SET (PYTHON_ASAPO_VERSION ${ASAPO_VERSION})
+ SET (ASAPO_WHEEL_VERSION ${ASAPO_VERSION})
endif()
message("Asapo Version: " ${ASAPO_VERSION})
diff --git a/VERSIONS.md b/VERSIONS.md
index 67aeaf798..4b9861da2 100644
--- a/VERSIONS.md
+++ b/VERSIONS.md
@@ -2,7 +2,7 @@
| Release | API changed | Breaking changes | Protocol | Supported by server up to | Status |
| ------------ | ----------- |----------------- | -------- | ------------------------- | ------- |
-| 21.03.0 | Yes | No | v0.1 | 21.03.0 | Current version |
+| 21.03.0 | Yes | Yes | v0.1 | 21.03.0 | Current version |
### Consumer API
diff --git a/examples/for_site/getting_started/install_cpp_clients.sh b/examples/for_site/getting_started/install_cpp_clients.sh
new file mode 100644
index 000000000..0c5ee3d9e
--- /dev/null
+++ b/examples/for_site/getting_started/install_cpp_clients.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# you can also install Linux/Windows packages if you have root access (or install locally).
+# take a look at http://nims.desy.de/extra/asapo/linux_packages/ or http://nims.desy.de/extra/asapo/windows10 for your OS. E.g. for Debian 10.7
+wget http://nims.desy.de/extra/asapo/linux_packages/debian10.7/asapo-dev-@ASAPO_VERSION@-debian10.7.x86_64.deb
+sudo apt install ./asapo-dev-@ASAPO_VERSION@-debian10.7.x86_64.deb
+
+
diff --git a/examples/for_site/getting_started/install_python_clients_pip.sh b/examples/for_site/getting_started/install_python_clients_pip.sh
new file mode 100644
index 000000000..117a4865b
--- /dev/null
+++ b/examples/for_site/getting_started/install_python_clients_pip.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+pip3 install --user --trusted-host nims.desy.de --find-links=http://nims.desy.de/extra/asapo/linux_wheels asapo_producer=@ASAPO_WHEEL_VERSION@
+pip3 install --user --trusted-host nims.desy.de --find-links=http://nims.desy.de/extra/asapo/linux_wheels asapo_consumer==@ASAPO_WHEEL_VERSION@
+# you might need to update pip if the above commands error: pip3 install --upgrade pip
+
+# if that does not work (abi incompatibility, etc) you may try to install source packages
+# take a look at http://nims.desy.de/extra/asapo/linux_packages/ or http://nims.desy.de/extra/asapo/windows10 for your OS. E.g. for Debian 10.7
+# wget http://nims.desy.de/extra/asapo/linux_packages/debian10.7/asapo_producer-@ASAPO_VERSION@.tar.gz
+# wget http://nims.desy.de/extra/asapo/linux_packages/debian10.7/asapo_consumer-@ASAPO_VERSION@.tar.gz
+# pip3 install asapo_producer-@ASAPO_VERSION@.tar.gz
+# pip3 install asapo_consumer-@ASAPO_VERSION@.tar.gz
\ No newline at end of file
diff --git a/examples/for_site/getting_started/install_python_clients_pkg.sh b/examples/for_site/getting_started/install_python_clients_pkg.sh
new file mode 100644
index 000000000..7abe5674e
--- /dev/null
+++ b/examples/for_site/getting_started/install_python_clients_pkg.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# you can also install Linux/Windows packages if you have root access (or install locally).
+# take a look at http://nims.desy.de/extra/asapo/linux_packages/ or http://nims.desy.de/extra/asapo/windows10 for your OS. E.g. for Debian 10.7
+wget http://nims.desy.de/extra/asapo/linux_packages/debian10.7/python-asapo-producer_@ASAPO_VERSION@-debian10.7_amd64.deb
+wget http://nims.desy.de/extra/asapo/linux_packages/debian10.7/python-asapo-consumer_@ASAPO_VERSION@-debian10.7_amd64.deb
+sudo apt install ./python3-asapo-producer_@ASAPO_VERSION@-debian10.7_amd64.deb
+sudo apt install ./python3-asapo_consumer_@ASAPO_VERSION@-debian10.7_amd64.deb
\ No newline at end of file
diff --git a/examples/for_site/getting_started/start_asapo_container.sh b/examples/for_site/getting_started/start_asapo_socket.sh
similarity index 98%
rename from examples/for_site/getting_started/start_asapo_container.sh
rename to examples/for_site/getting_started/start_asapo_socket.sh
index 3a7c66fe6..909b4cec8 100644
--- a/examples/for_site/getting_started/start_asapo_container.sh
+++ b/examples/for_site/getting_started/start_asapo_socket.sh
@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
set -e
diff --git a/examples/for_site/getting_started/start_asapo_tcp.sh b/examples/for_site/getting_started/start_asapo_tcp.sh
new file mode 100644
index 000000000..3bd68d1bb
--- /dev/null
+++ b/examples/for_site/getting_started/start_asapo_tcp.sh
@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+set -e
+
+ASAPO_HOST_DIR=/var/tmp/asapo # you can change this if needed, make sure there is enough space ( >3GB on disk)
+# change this according to your Docker configuration
+DOCKER_ENDPOINT="127.0.0.1:2376"
+DOCKER_TLS_CA=/usr/local/docker/certs/$USER/ca.pem
+DOCKER_TLS_KEY=/usr/local/docker/certs/$USER/key.pem
+DOCKER_TLS_CERT=/usr/local/docker/certs/$USER/cert.pem
+
+
+NOMAD_ALLOC_HOST_SHARED=$ASAPO_HOST_DIR/container_host_shared/nomad_alloc
+SERVICE_DATA_CLUSTER_SHARED=$ASAPO_HOST_DIR/asapo_cluster_shared/service_data
+DATA_GLOBAL_SHARED=$ASAPO_HOST_DIR/global_shared/data
+DATA_GLOBAL_SHARED_ONLINE=$ASAPO_HOST_DIR/global_shared/online_data
+MONGO_DIR=$SERVICE_DATA_CLUSTER_SHARED/mongodb
+
+ASAPO_USER=`id -u`:`id -g`
+
+mkdir -p $NOMAD_ALLOC_HOST_SHARED $SERVICE_DATA_CLUSTER_SHARED $DATA_GLOBAL_SHARED $DATA_GLOBAL_SHARED_ONLINE
+chmod 777 $NOMAD_ALLOC_HOST_SHARED $SERVICE_DATA_CLUSTER_SHARED $DATA_GLOBAL_SHARED $DATA_GLOBAL_SHARED_ONLINE
+
+cd $SERVICE_DATA_CLUSTER_SHARED
+mkdir -p fluentd grafana influxdb2 mongodb
+chmod 777 *
+
+docker run --privileged --userns=host --security-opt no-new-privileges --rm \
+ -u $ASAPO_USER \
+ -v $NOMAD_ALLOC_HOST_SHARED:$NOMAD_ALLOC_HOST_SHARED \
+ -v $SERVICE_DATA_CLUSTER_SHARED:$SERVICE_DATA_CLUSTER_SHARED \
+ -v $DATA_GLOBAL_SHARED:$DATA_GLOBAL_SHARED \
+ -e NOMAD_ALLOC_DIR=$NOMAD_ALLOC_HOST_SHARED \
+ -e TF_VAR_service_dir=$SERVICE_DATA_CLUSTER_SHARED \
+ -e TF_VAR_online_dir=$DATA_GLOBAL_SHARED_ONLINE \
+ -e TF_VAR_offline_dir=$DATA_GLOBAL_SHARED \
+ -e TF_VAR_mongo_dir=$MONGO_DIR \
+ -e TF_VAR_asapo_user=$ASAPO_USER \
+ -e ACL_ENABLED=true \
+ -v $DOCKER_TLS_CA:/etc/nomad/ca.pem \
+ -v $DOCKER_TLS_KEY:/etc/nomad/key.pem \
+ -v $DOCKER_TLS_CERT:/etc/nomad/cert.pem \
+ -e DOCKER_ENDPOINT=$DOCKER_ENDPOINT \
+ --name asapo --net=host -d yakser/asapo-cluster:@ASAPO_VERSION@
+
+sleep 15
+docker exec asapo jobs-start -var elk_logs=false
--
GitLab