Skip to content
Snippets Groups Projects
Commit f4a2a7ce authored by Mikhail Karnevskiy's avatar Mikhail Karnevskiy
Browse files

Modify documentation to prepare for 23.12.0 release. Remove 23.11.0.

parent b8040fdd
Branches
No related tags found
No related merge requests found
Showing
with 97 additions and 83 deletions
---
title: Version 23.11.0
title: Version 23.12.0
author: Mikhail Karnevskiy
author_title: DESY IT
tags: [release]
---
#Changelog for version 23.11.0
#Changelog for version 23.12.0
FEATURES
* Consumer API: `get_next` and `get_next_dataset` now have a flag `ordered` with default value `true` (for back compatibility). If flag is set to `false` function will deliver next available message. In case of `dataset` it will deliver messages ordered by arrival time of the first subset in the dataset.
......
......@@ -22,14 +22,14 @@ You can found the full example in git repository.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/acknowledgements.py" snippetTag="consume"
```python content="./versioned_examples/version-23.12.0/python/acknowledgements.py" snippetTag="consume"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/acknowledgements.cpp" snippetTag="consume"
```cpp content="./versioned_examples/version-23.12.0/cpp/acknowledgements.cpp" snippetTag="consume"
```
</TabItem>
......@@ -47,14 +47,14 @@ The list of unacknowledged messages can be accessed at any time. This snippet pr
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/acknowledgements.py" snippetTag="print"
```python content="./versioned_examples/version-23.12.0/python/acknowledgements.py" snippetTag="print"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/acknowledgements.cpp" snippetTag="print"
```cpp content="./versioned_examples/version-23.12.0/cpp/acknowledgements.cpp" snippetTag="print"
```
</TabItem>
......
......@@ -22,14 +22,14 @@ Here is the code snippet that can be used to produce a three-parted dataset. The
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/produce_dataset.py" snippetTag="dataset"
```python content="./versioned_examples/version-23.12.0/python/produce_dataset.py" snippetTag="dataset"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/produce_dataset.cpp" snippetTag="dataset"
```cpp content="./versioned_examples/version-23.12.0/cpp/produce_dataset.cpp" snippetTag="dataset"
```
</TabItem>
......@@ -51,14 +51,14 @@ Here is the snippet that can be used to consume a dataset. The full example is a
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/consume_dataset.py" snippetTag="dataset"
```python content="./versioned_examples/version-23.12.0/python/consume_dataset.py" snippetTag="dataset"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/consume_dataset.cpp" snippetTag="dataset"
```cpp content="./versioned_examples/version-23.12.0/cpp/consume_dataset.cpp" snippetTag="dataset"
```
</TabItem>
......
......@@ -8,7 +8,7 @@ If you want to interactively test the simple producer/consumer functionality, yo
<details>
<summary>Producer GUI full code</summary>
```python content="./versioned_examples/version-23.11.0/python/produce_ui.py"
```python content="./versioned_examples/version-23.12.0/python/produce_ui.py"
```
</details>
......@@ -16,7 +16,7 @@ If you want to interactively test the simple producer/consumer functionality, yo
<details>
<summary>Consumer GUI full code</summary>
```python content="./versioned_examples/version-23.11.0/python/consume_ui.py"
```python content="./versioned_examples/version-23.12.0/python/consume_ui.py"
```
</details>
......
......@@ -27,7 +27,7 @@ The following snippet shows how to send the beamtime metadata.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/metadata.py" snippetTag="beamtime_set"
```python content="./versioned_examples/version-23.12.0/python/metadata.py" snippetTag="beamtime_set"
```
</TabItem>
......@@ -35,7 +35,7 @@ The following snippet shows how to send the beamtime metadata.
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/metadata.cpp" snippetTag="beamtime_set"
```cpp content="./versioned_examples/version-23.12.0/cpp/metadata.cpp" snippetTag="beamtime_set"
```
</TabItem>
......@@ -53,7 +53,7 @@ Each metadata can be updated at any moment. Here is the example on how to do it
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/metadata.py" snippetTag="beamtime_update"
```python content="./versioned_examples/version-23.12.0/python/metadata.py" snippetTag="beamtime_update"
```
</TabItem>
......@@ -61,7 +61,7 @@ Each metadata can be updated at any moment. Here is the example on how to do it
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/metadata.cpp" snippetTag="beamtime_update"
```cpp content="./versioned_examples/version-23.12.0/cpp/metadata.cpp" snippetTag="beamtime_update"
```
</TabItem>
......@@ -79,7 +79,7 @@ The same way the metadata can be set for each stream.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/metadata.py" snippetTag="stream_set"
```python content="./versioned_examples/version-23.12.0/python/metadata.py" snippetTag="stream_set"
```
</TabItem>
......@@ -87,7 +87,7 @@ The same way the metadata can be set for each stream.
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/metadata.cpp" snippetTag="stream_set"
```cpp content="./versioned_examples/version-23.12.0/cpp/metadata.cpp" snippetTag="stream_set"
```
</TabItem>
......@@ -105,7 +105,7 @@ And for each message
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/metadata.py" snippetTag="message_set"
```python content="./versioned_examples/version-23.12.0/python/metadata.py" snippetTag="message_set"
```
</TabItem>
......@@ -113,7 +113,7 @@ And for each message
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/metadata.cpp" snippetTag="message_set"
```cpp content="./versioned_examples/version-23.12.0/cpp/metadata.cpp" snippetTag="message_set"
```
</TabItem>
......@@ -133,7 +133,7 @@ Here we will read the beamtime metadata. In this example it will already incorpo
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/metadata.py" snippetTag="beamtime_get"
```python content="./versioned_examples/version-23.12.0/python/metadata.py" snippetTag="beamtime_get"
```
</TabItem>
......@@ -141,7 +141,7 @@ Here we will read the beamtime metadata. In this example it will already incorpo
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/metadata.cpp" snippetTag="beamtime_get"
```cpp content="./versioned_examples/version-23.12.0/cpp/metadata.cpp" snippetTag="beamtime_get"
```
</TabItem>
......@@ -159,7 +159,7 @@ Same for the stream.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/metadata.py" snippetTag="stream_get"
```python content="./versioned_examples/version-23.12.0/python/metadata.py" snippetTag="stream_get"
```
</TabItem>
......@@ -167,7 +167,7 @@ Same for the stream.
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/metadata.cpp" snippetTag="stream_get"
```cpp content="./versioned_examples/version-23.12.0/cpp/metadata.cpp" snippetTag="stream_get"
```
</TabItem>
......@@ -185,7 +185,7 @@ And for the message.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/metadata.py" snippetTag="message_get"
```python content="./versioned_examples/version-23.12.0/python/metadata.py" snippetTag="message_get"
```
</TabItem>
......@@ -193,7 +193,7 @@ And for the message.
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/metadata.cpp" snippetTag="message_get"
```cpp content="./versioned_examples/version-23.12.0/cpp/metadata.cpp" snippetTag="message_get"
```
</TabItem>
......
......@@ -20,14 +20,14 @@ The setting of the next stream is done by providing an additional parameter whil
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/next_stream.py" snippetTag="next_stream_set"
```python content="./versioned_examples/version-23.12.0/python/next_stream.py" snippetTag="next_stream_set"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/next_stream.cpp" snippetTag="next_stream_set"
```cpp content="./versioned_examples/version-23.12.0/cpp/next_stream.cpp" snippetTag="next_stream_set"
```
</TabItem>
......@@ -45,14 +45,14 @@ The reading of the streams can be then chained together. When one stream finishe
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/next_stream.py" snippetTag="read_stream"
```python content="./versioned_examples/version-23.12.0/python/next_stream.py" snippetTag="read_stream"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/next_stream.cpp" snippetTag="read_stream"
```cpp content="./versioned_examples/version-23.12.0/cpp/next_stream.cpp" snippetTag="read_stream"
```
</TabItem>
......
......@@ -26,14 +26,14 @@ Here we can pick a message with the specific ID.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/query.py" snippetTag="by_id"
```python content="./versioned_examples/version-23.12.0/python/query.py" snippetTag="by_id"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/query.cpp" snippetTag="by_id"
```cpp content="./versioned_examples/version-23.12.0/cpp/query.cpp" snippetTag="by_id"
```
</TabItem>
......@@ -51,14 +51,14 @@ We can also use the simple rule for picking a range of IDs
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/query.py" snippetTag="by_ids"
```python content="./versioned_examples/version-23.12.0/python/query.py" snippetTag="by_ids"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/query.cpp" snippetTag="by_ids"
```cpp content="./versioned_examples/version-23.12.0/cpp/query.cpp" snippetTag="by_ids"
```
</TabItem>
......@@ -76,14 +76,14 @@ We can query the messages based on their metadata, for example request a specifi
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/query.py" snippetTag="string_equal"
```python content="./versioned_examples/version-23.12.0/python/query.py" snippetTag="string_equal"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/query.cpp" snippetTag="string_equal"
```cpp content="./versioned_examples/version-23.12.0/cpp/query.cpp" snippetTag="string_equal"
```
</TabItem>
......@@ -101,14 +101,14 @@ We can also require some more complex constraints on the metadata, e.g. a range
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/query.py" snippetTag="int_compare"
```python content="./versioned_examples/version-23.12.0/python/query.py" snippetTag="int_compare"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/query.cpp" snippetTag="int_compare"
```cpp content="./versioned_examples/version-23.12.0/cpp/query.cpp" snippetTag="int_compare"
```
</TabItem>
......@@ -126,14 +126,14 @@ Since every message comes with a timestamp, we can make constraints on it as wel
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/query.py" snippetTag="timestamp"
```python content="./versioned_examples/version-23.12.0/python/query.py" snippetTag="timestamp"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/query.cpp" snippetTag="timestamp"
```cpp content="./versioned_examples/version-23.12.0/cpp/query.cpp" snippetTag="timestamp"
```
</TabItem>
......
......@@ -23,21 +23,21 @@ First step is to create an instance of the consumer.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/consume.py" snippetTag="create"
```python content="./versioned_examples/version-23.12.0/python/consume.py" snippetTag="create"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/consume.cpp" snippetTag="create"
```cpp content="./versioned_examples/version-23.12.0/cpp/consume.cpp" snippetTag="create"
```
</TabItem>
<TabItem value="c">
```c content="./versioned_examples/version-23.11.0/c/consume.c" snippetTag="create"
```c content="./versioned_examples/version-23.12.0/c/consume.c" snippetTag="create"
```
</TabItem>
......@@ -57,14 +57,14 @@ You can list all the streams within the beamtime.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/consume.py" snippetTag="list"
```python content="./versioned_examples/version-23.12.0/python/consume.py" snippetTag="list"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/consume.cpp" snippetTag="list"
```cpp content="./versioned_examples/version-23.12.0/cpp/consume.cpp" snippetTag="list"
```
</TabItem>
......@@ -86,21 +86,21 @@ You need to use the group ID that can be used by several consumer in parallel. Y
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/consume.py" snippetTag="consume"
```python content="./versioned_examples/version-23.12.0/python/consume.py" snippetTag="consume"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/consume.cpp" snippetTag="consume"
```cpp content="./versioned_examples/version-23.12.0/cpp/consume.cpp" snippetTag="consume"
```
</TabItem>
<TabItem value="c">
```c content="./versioned_examples/version-23.11.0/c/consume.c" snippetTag="consume"
```c content="./versioned_examples/version-23.12.0/c/consume.c" snippetTag="consume"
```
</TabItem>
......@@ -120,21 +120,21 @@ After consuming the stream you can delete it.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/consume.py" snippetTag="delete"
```python content="./versioned_examples/version-23.12.0/python/consume.py" snippetTag="delete"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/consume.cpp" snippetTag="delete"
```cpp content="./versioned_examples/version-23.12.0/cpp/consume.cpp" snippetTag="delete"
```
</TabItem>
<TabItem value="c">
```c content="./versioned_examples/version-23.11.0/c/consume.c" snippetTag="delete"
```c content="./versioned_examples/version-23.12.0/c/consume.c" snippetTag="delete"
```
</TabItem>
......@@ -164,7 +164,7 @@ For C++ example you need to compiled it first. The easiest way to do it is by in
The example CMake file can look like this
```cmake content="./versioned_examples/version-23.11.0/cpp/CMakeLists.txt" snippetTag="#consumer"
```cmake content="./versioned_examples/version-23.12.0/cpp/CMakeLists.txt" snippetTag="#consumer"
```
You can use it like this
......@@ -179,7 +179,7 @@ $ ./asapo-consume
<TabItem value="c">
Compile e.g. using Makefile and pkg-config (although we recommend CMake - see C++ section) and execute. This example assumes asapo is installed to /opt/asapo. Adjust correspondingly.
```makefile content="./versioned_examples/version-23.11.0/c/Makefile" snippetTag="#consumer"
```makefile content="./versioned_examples/version-23.12.0/c/Makefile" snippetTag="#consumer"
```
```
......
......@@ -20,14 +20,14 @@ Here is the snippet that shows how to organize a pipelined loop. The full runnab
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/pipeline.py" snippetTag="pipeline"
```python content="./versioned_examples/version-23.12.0/python/pipeline.py" snippetTag="pipeline"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/pipeline.cpp" snippetTag="pipeline"
```cpp content="./versioned_examples/version-23.12.0/cpp/pipeline.cpp" snippetTag="pipeline"
```
</TabItem>
......@@ -45,14 +45,14 @@ Just like with any produced stream, the pipelined stream can be marked as "finis
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/pipeline.py" snippetTag="finish"
```python content="./versioned_examples/version-23.12.0/python/pipeline.py" snippetTag="finish"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/pipeline.cpp" snippetTag="finish"
```cpp content="./versioned_examples/version-23.12.0/cpp/pipeline.cpp" snippetTag="finish"
```
</TabItem>
......
......@@ -20,14 +20,14 @@ First step is to create an instance of the producer.
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/produce.py" snippetTag="create"
```python content="./versioned_examples/version-23.12.0/python/produce.py" snippetTag="create"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/produce.cpp" snippetTag="create"
```cpp content="./versioned_examples/version-23.12.0/cpp/produce.cpp" snippetTag="create"
```
</TabItem>
......@@ -45,14 +45,14 @@ Then, we need to define a callback that would be used for sending. The callback
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/produce.py" snippetTag="callback"
```python content="./versioned_examples/version-23.12.0/python/produce.py" snippetTag="callback"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/produce.cpp" snippetTag="callback"
```cpp content="./versioned_examples/version-23.12.0/cpp/produce.cpp" snippetTag="callback"
```
</TabItem>
......@@ -70,14 +70,14 @@ Next we schedule the actual sending. This function call does not perform the act
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/produce.py" snippetTag="send"
```python content="./versioned_examples/version-23.12.0/python/produce.py" snippetTag="send"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/produce.cpp" snippetTag="send"
```cpp content="./versioned_examples/version-23.12.0/cpp/produce.cpp" snippetTag="send"
```
</TabItem>
......@@ -95,14 +95,14 @@ The sending of the messages will probably be done in a loop. After all the data
}>
<TabItem value="python">
```python content="./versioned_examples/version-23.11.0/python/produce.py" snippetTag="finish"
```python content="./versioned_examples/version-23.12.0/python/produce.py" snippetTag="finish"
```
</TabItem>
<TabItem value="cpp">
```cpp content="./versioned_examples/version-23.11.0/cpp/produce.cpp" snippetTag="finish"
```cpp content="./versioned_examples/version-23.12.0/cpp/produce.cpp" snippetTag="finish"
```
</TabItem>
......@@ -132,7 +132,7 @@ For C++ example you need to compiled it first. The easiest way to do it is by in
The example CMake file can look like this.
```cmake content="./versioned_examples/version-23.11.0/cpp/CMakeLists.txt" snippetTag="#producer"
```cmake content="./versioned_examples/version-23.12.0/cpp/CMakeLists.txt" snippetTag="#producer"
```
You can use it like this.
......
......@@ -17,26 +17,40 @@ Otherwise, for testing purposes one can start ASAPO services in a standalone mod
docker login gitlab.desy.de:5555
```
To start asapo standalone container simply do
To start asapo standalone container simply do:
```shell
docker run --name asapo --network host gitlab.desy.de:5555/asapo/asapo/asapo-standalone-dev:latest
<Tabs
defaultValue="simple"
values={[
{ label: 'Simple start', value: 'simple', },
{ label: 'Persist data', value: 'persist', },
{ label: 'Start on Maxwell', value: 'maxwell', },
]
}>
<TabItem value="simple">
```shell content="./versioned_examples/version-23.12.0/start_asapo_simple.sh"
```
The container launched in such a way will loose all the information on shutdown. If you want to persist your data, you need to use mounted volumes.
</TabItem>
<TabItem value="persist">
```shell
LOCAL_MONGODB=~/asapo_mongodb # path for the local folder where the mongodb data will be saved, used for the metadata and message control
LOCAL_INFLUXDB=~/asapo_influxdb # path for the local folder where the influxdb data will be saved, used for statistics and monitoring
LOCAL_DATAFOLDER=~/asapo_data # path for the local data folder where the actual files will be saved
LOCAL_LOGSFOLDER=~/asapo_logs # path for the local folder for the logs
docker run --name asapo -v ${LOCAL_MONGODB}:/var/lib/mongodb/ \
-v ${LOCAL_INFLUXDB}:/var/lib/influxdb/ \
-v ${LOCAL_DATAFOLDER}:/tmp/asapo/receiver/files/test_facility/gpfs/test/2019/data/ \
-v ${LOCAL_LOGSFOLDER}:/tmp/logs/ \
--network host gitlab.desy.de:5555/asapo/asapo/asapo-standalone-dev:latest
```shell content="./versioned_examples/version-23.12.0/start_asapo_persist.sh"
```
</TabItem>
<TabItem value="maxwell">
```shell content="./versioned_examples/version-23.12.0/start_asapo_maxwell.sh"
```
</TabItem>
</Tabs>
The container launched in such a way will loose all the information on shutdown. If you want to persist your data, you need to use mounted volumes. In order to run asapo docker on Maxwell nodes one need to manually bound asapo ports.
After the container was created in such a manner, all the consecutive launches can be done via simple commands
```shell
......@@ -60,19 +74,19 @@ Now you can install Python packages or C++ libraries for ASAPO Producer and Cons
}>
<TabItem value="python-pip">
```shell content="./versioned_examples/version-23.11.0/install_python_clients_pip.sh" snippetTag="#snippet1"
```shell content="./versioned_examples/version-23.12.0/install_python_clients_pip.sh" snippetTag="#snippet1"
```
</TabItem>
<TabItem value="python-packages">
```shell content="./versioned_examples/version-23.11.0/install_python_clients_pkg.sh"
```shell content="./versioned_examples/version-23.12.0/install_python_clients_pkg.sh"
```
</TabItem>
<TabItem value="cpp">
```shell content="./versioned_examples/version-23.11.0/install_cpp_clients.sh"
```shell content="./versioned_examples/version-23.12.0/install_cpp_clients.sh"
```
</TabItem>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment