Skip to content

Commit

Permalink
Merge pull request #310 from bettio/prepare-0.11.0
Browse files Browse the repository at this point in the history
Prepare 0.11.0
  • Loading branch information
rbino authored Apr 13, 2020
2 parents 7665b53 + c019189 commit 1845d8b
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion doc/pages/administrator/040-manual_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ for the Operator are. Ensure you're cloning the right branch for the Operator Ve
For example, if you want to Deploy an Operator in the 0.11 series, you would

```bash
git clone -b release-0.11 https://github.com/astarte-platform/astarte-kubernetes-operator.git
git clone -b v0.11.0 https://github.com/astarte-platform/astarte-kubernetes-operator.git
```

## Install RBACs and CRDs
Expand Down
6 changes: 3 additions & 3 deletions doc/pages/administrator/060-setup_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ managed installation.

`astartectl` comes packed with a set of default profiles, but you can write your own ones. Profiles can
be either written as Go resources, or (in a much easier fashion) as `yaml` resources. You can have a look
at the [Profiles schema here](https://github.com/astarte-platform/astartectl/blob/master/cmd/cluster/deployment/astarte_cluster_profile.go).
at the [Profiles schema here](https://github.com/astarte-platform/astartectl/blob/v0.11.0/cmd/cluster/deployment/astarte_cluster_profile.go).

### Writing your own profile

Expand All @@ -31,7 +31,7 @@ profiles.
If you do not want to use `astartectl` or Profiles, you can create your own Astarte Custom Resource. This gives you
a higher degree of customization, allowing you to tweak any single parameter in the Astarte setup. The main
Astarte CRD contains
[extensive documentation](https://github.com/astarte-platform/astarte-kubernetes-operator/blob/master/deploy/crds/api.astarte-platform.org_astartes_crd.yaml)
[extensive documentation](https://github.com/astarte-platform/astarte-kubernetes-operator/blob/v0.11.0/deploy/crds/api.astarte-platform.org_astartes_crd.yaml)
on the available fields in OpenAPIv3 format. Just create your Astarte Custom Resource, which will look something
like this:

Expand All @@ -44,7 +44,7 @@ metadata:
spec:
# This is the most minimal set of reasonable configuration to spin up an Astarte
# instance with reasonable defaults and enough control over the deployment.
version: 0.11.0-rc.1
version: 0.11.0
api:
host: "api.astarte.yourdomain.com" # MANDATORY
rabbitmq:
Expand Down
2 changes: 1 addition & 1 deletion doc/pages/administrator/065-setup_ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,5 @@ In particular, assuming your API host was `api.astarte.yourdomain.com`:

`AstarteVoyagerIngress` has a number of advanced options that can be used to accommodate needs of the most diverse
deployments. Consult the
[CRD Documentation](https://github.com/astarte-platform/astarte-kubernetes-operator/blob/master/deploy/crds/api.astarte-platform.org_astartevoyageringresses_crd.yaml)
[CRD Documentation](https://github.com/astarte-platform/astarte-kubernetes-operator/blob/v0.11.0/deploy/crds/api.astarte-platform.org_astartevoyageringresses_crd.yaml)
to learn more.
14 changes: 7 additions & 7 deletions doc/pages/tutorials/010-astarte_in_5_minutes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Also, on the machine(s) or device(s) you will use as a client, you will need eit
To get our Astarte instance running as fast as possible, we will install Astarte's standalone distribution. It includes a tunable Docker Compose which brings up Astarte and every companion service needed for it to work. To do so, simply clone Astarte's main repository and use its scripts to bring it up:

```sh
$ git clone https://github.com/astarte-platform/astarte.git -b v0.11.0-rc.1 && cd astarte
$ git clone https://github.com/astarte-platform/astarte.git -b v0.11.0 && cd astarte
$ docker run -v $(pwd)/compose:/compose astarte/docker-compose-initializer
$ docker-compose up -d
```
Expand Down Expand Up @@ -125,18 +125,18 @@ Depending on what your client supports, you can either compile `stream-qt5-test`
Astarte's `stream-qt5-test` can be pulled from Docker Hub with:

```sh
$ docker pull astarte/astarte-stream-qt5-test:0.11.0-rc.1
$ docker pull astarte/astarte-stream-qt5-test:0.11.0
```

Its most basic invocation (from your `astarte` repository tree) is:

```sh
$ docker run --net="host" -e "DEVICE_ID=$(astartectl utils device-id generate-random)" -e "PAIRING_HOST=http://localhost:4003" -e "REALM=test" -e "AGENT_KEY=$(astartectl utils gen-jwt pairing -k test_private.pem)" -e "IGNORE_SSL_ERRORS=true" astarte/astarte-stream-qt5-test:0.11.0-rc.1
$ docker run --net="host" -e "DEVICE_ID=$(astartectl utils device-id generate-random)" -e "PAIRING_HOST=http://localhost:4003" -e "REALM=test" -e "AGENT_KEY=$(astartectl utils gen-jwt pairing -k test_private.pem)" -e "IGNORE_SSL_ERRORS=true" astarte/astarte-stream-qt5-test:0.11.0
```

This will generate a random datastream from a brand new, random Device ID. You can tweak those parameters to whatever suits you better by having a look at the Dockerfile. You can spawn any number of instances you like, or you can have the same Device ID send longer streams of data by saving the container's persistency through a Docker Volume. If you wish to do so, simply add `-v /persistency:<your persistency path>` to your `docker run` invocation.

Refer to `stream-qt5-test` [README](https://github.com/astarte-platform/stream-qt5-test/blob/master/README.md) for more details on which variables can be passed to the container.
Refer to `stream-qt5-test` [README](https://github.com/astarte-platform/stream-qt5-test/blob/v0.11.0/README.md) for more details on which variables can be passed to the container.

Also, please note that the `--net="host"` parameter is required to make `localhost` work. If this is not desirable, you can change `PAIRING_HOST` to an host reachable from within the container network. Obviously, that parameter isn't required if you're running the container on a different machine and `PAIRING_HOST` is pointing to a different URL.

Expand All @@ -151,21 +151,21 @@ If your target platform does not support running containers, you can build `stre
Once your dependencies are installed, compile your components:

```sh
$ git clone https://github.com/astarte-platform/astarte-device-sdk-qt5.git -b v0.11.0-rc.1
$ git clone https://github.com/astarte-platform/astarte-device-sdk-qt5.git -b v0.11.0
$ cd astarte-device-sdk-qt5
$ mkdir build
$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX=/usr ..
$ make
$ make install
$ cd -
$ git clone https://github.com/astarte-platform/stream-qt5-test.git -b v0.11.0-rc.1
$ git clone https://github.com/astarte-platform/stream-qt5-test.git -b v0.11.0
$ cd stream-qt5-test
$ qmake .
$ make
```

You can now run `stream-qt5-test` from your last build directory. Refer to its [README](https://github.com/astarte-platform/stream-qt5-test/blob/master/README.md) (or to its sources) to learn about how to use it and which options are available.
You can now run `stream-qt5-test` from your last build directory. Refer to its [README](https://github.com/astarte-platform/stream-qt5-test/blob/v0.11.0/README.md) (or to its sources) to learn about how to use it and which options are available.

## Grab your tea

Expand Down
4 changes: 2 additions & 2 deletions doc/pages/user/052-using_channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Rooms in Astarte Channels map 1:1 to Topics in Phoenix Channels, and can be join

A Room is identified by a topic with the following semantics: `rooms:<realm>:<name>`. For example, `rooms:test:myroom` will join the Room `myroom` in the Realm `test`.

A room can be joined by any number of concurrent users. Rooms serve as containers for Transient Triggers, which can be installed by any authorized user. Transient Triggers are actual [Triggers](060-triggers.md), with the difference that they exist within a Channels Room rather than within a Realm - this mostly affects their timespan - and that the `action` can't be configured - every time a Condition is triggered a message is delivered to users in the Room, [in a well-known format](https://github.com/astarte-platform/astarte_core/tree/master/lib/astarte_core/triggers/simple_events).
A room can be joined by any number of concurrent users. Rooms serve as containers for Transient Triggers, which can be installed by any authorized user. Transient Triggers are actual [Triggers](060-triggers.md), with the difference that they exist within a Channels Room rather than within a Realm - this mostly affects their timespan - and that the `action` can't be configured - every time a Condition is triggered a message is delivered to users in the Room, [in a well-known format](https://github.com/astarte-platform/astarte_core/blob/v0.11.0/lib/astarte_core/triggers/simple_events/encoder.ex).

### Events

Expand All @@ -26,7 +26,7 @@ Everytime a Condition of an installed Trigger is triggered, an event is sent to
}
```

`device_id` is always present (as long as the trigger matches a device) and identifies the device emitting the event. `event`, instead, depends on the kind of installed trigger. It always carries a `type` string, which identifies the content of the object. Currently, the documentation of every event's payload can be found in [Astarte's protobuf files](https://github.com/astarte-platform/astarte_core/tree/master/lib/astarte_core/triggers/simple_events). However, there are some discrepancies in mapping (e.g.). It is advised also to have a look at the [encoder](https://github.com/astarte-platform/astarte_core/blob/master/lib/astarte_core/triggers/simple_events/encoder.ex). In the foreseeable future, more user friendly documentation will be provided.
`device_id` is always present (as long as the trigger matches a device) and identifies the device emitting the event. `event`, instead, depends on the kind of installed trigger. It always carries a `type` string, which identifies the content of the object. Currently, the documentation of every event's payload can be found in [Astarte's protobuf files](https://github.com/astarte-platform/astarte_core/tree/v0.11.0/lib/astarte_core/triggers/simple_events). However, there are some discrepancies in mapping (e.g.). It is advised also to have a look at the [encoder](https://github.com/astarte-platform/astarte_core/blob/v0.11.0/lib/astarte_core/triggers/simple_events/encoder.ex). In the foreseeable future, more user friendly documentation will be provided.

### Lifecycle

Expand Down
24 changes: 12 additions & 12 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '2'
services:
astarte-housekeeping:
image: astarte/astarte_housekeeping:0.11.0-rc.1
image: astarte/astarte_housekeeping:0.11.0
env_file:
- ./compose.env
ports:
Expand All @@ -12,7 +12,7 @@ services:
- "scylla"

astarte-housekeeping-api:
image: astarte/astarte_housekeeping_api:0.11.0-rc.1
image: astarte/astarte_housekeeping_api:0.11.0
env_file:
- ./compose.env
environment:
Expand All @@ -26,7 +26,7 @@ services:
- "rabbitmq"

astarte-realm-management:
image: astarte/astarte_realm_management:0.11.0-rc.1
image: astarte/astarte_realm_management:0.11.0
env_file:
- ./compose.env
ports:
Expand All @@ -37,7 +37,7 @@ services:
- "scylla"

astarte-realm-management-api:
image: astarte/astarte_realm_management_api:0.11.0-rc.1
image: astarte/astarte_realm_management_api:0.11.0
env_file:
- ./compose.env
ports:
Expand All @@ -47,7 +47,7 @@ services:
- "rabbitmq"

astarte-pairing:
image: astarte/astarte_pairing:0.11.0-rc.1
image: astarte/astarte_pairing:0.11.0
env_file:
- ./compose.env
ports:
Expand All @@ -60,7 +60,7 @@ services:
- "scylla"

astarte-pairing-api:
image: astarte/astarte_pairing_api:0.11.0-rc.1
image: astarte/astarte_pairing_api:0.11.0
env_file:
- ./compose.env
ports:
Expand All @@ -70,7 +70,7 @@ services:
- "rabbitmq"

astarte-appengine-api:
image: astarte/astarte_appengine_api:0.11.0-rc.1
image: astarte/astarte_appengine_api:0.11.0
env_file:
- ./compose.env
environment:
Expand All @@ -86,7 +86,7 @@ services:
- "scylla"

astarte-data-updater-plant:
image: astarte/astarte_data_updater_plant:0.11.0-rc.1
image: astarte/astarte_data_updater_plant:0.11.0
env_file:
- ./compose.env
ports:
Expand All @@ -104,7 +104,7 @@ services:
- "scylla"

astarte-trigger-engine:
image: astarte/astarte_trigger_engine:0.11.0-rc.1
image: astarte/astarte_trigger_engine:0.11.0
env_file:
- ./compose.env
ports:
Expand All @@ -117,7 +117,7 @@ services:
- "scylla"

astarte-dashboard:
image: astarte/astarte-dashboard:0.11.0-rc.1
image: astarte/astarte-dashboard:0.11.0
ports:
- "4040:80"
volumes:
Expand All @@ -127,7 +127,7 @@ services:
- "astarte-appengine-api"

astarte-grafana:
image: astarte/grafana:0.11.0-rc.1
image: astarte/grafana:0.11.0
ports:
- "3000:3000"
depends_on:
Expand Down Expand Up @@ -168,7 +168,7 @@ services:

# VerneMQ
vernemq:
image: astarte/vernemq:0.11.0-rc.1
image: astarte/vernemq:0.11.0
env_file:
- ./compose.env
environment:
Expand Down

0 comments on commit 1845d8b

Please sign in to comment.