Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add v3.29.0 release docs #1267

Merged
merged 2 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ pygmentsUseClasses = true
github_repository = "https://github.com/TheThingsIndustries/lorawan-stack-docs"
github_repository_edit = "https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content"
tts_github_repository = "https://github.com/TheThingsNetwork/lorawan-stack"
version = "3.28.2"
version = "3.29.0"

[markup]
[markup.goldmark]
Expand Down
6 changes: 6 additions & 0 deletions doc/content/reference/api/end_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -522,8 +522,12 @@ See the [EndDevice message](#message:EndDevice) and its sub-messages for additio

{{< proto/message message="Secret" >}}

{{< proto/message message="ServedRelaySettings" >}}

{{< proto/message message="ServedRelayParameters" >}}

{{< proto/message message="ServingRelaySettings" >}}

{{< proto/message message="ServingRelayParameters" >}}

{{< proto/message message="RelayUplinkForwardingRule" >}}
Expand Down Expand Up @@ -606,6 +610,8 @@ See the [EndDevice message](#message:EndDevice) and its sub-messages for additio

{{< proto/enum enum="RelaySecondChAckOffset" >}}

{{< proto/message message="RelaySettings" >}}

{{< proto/enum enum="RelaySmartEnableLevel" >}}

{{< proto/enum enum="RelayLimitBucketSize" >}}
Expand Down
2 changes: 2 additions & 0 deletions doc/content/reference/api/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ The Gateway Server exposes the list of available frequency plans with the `Confi

## Messages

{{< proto/message message="AlertNotificationProfileIdentifiers" >}}

{{< proto/message message="APIKey" >}}

{{< proto/message message="APIKeys" >}}
Expand Down
68 changes: 68 additions & 0 deletions doc/content/reference/api/identity_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,54 @@ description: ""

{{< proto/method service="GatewayBatchRegistry" method="Delete" >}}

## The `AlertNotificationProfileRegistry` service

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Create" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Get" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="List" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Update" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Delete" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="GetDefault" >}}

## The `AlertNotificationReceiverRegistry` service

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Create" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Get" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="List" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Update" >}}

{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Delete" >}}

## The `Ars` service

{{< proto/method package="tti.lorawan.v3" service="Ars" method="GetConfiguration" >}}

## Messages

{{< proto/message package="tti.lorawan.v3" message="AlertNotificationProfile" >}}

{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiverIdentifiers" >}}

{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver" >}}

{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.Email" >}}

{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.SMS" >}}

{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.Webhook" >}}

{{< proto/message package="tti.lorawan.v3" message="ArsConfiguration" >}}

{{< proto/message package="tti.lorawan.v3" message="ArsConfiguration.Routing" >}}

{{< proto/message message="AssertGatewayRightsRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="AuthenticationProvider" >}}
Expand All @@ -71,6 +117,10 @@ description: ""

{{< proto/message message="ContactInfoValidation" >}}

{{< proto/message package="tti.lorawan.v3" message="CreateAlertNotificationProfileRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="CreateAlertNotificationReceiverRequest" >}}

{{< proto/message message="EndDeviceIdentifiers" >}}

{{< proto/message message="EntityIdentifiers" >}}
Expand All @@ -97,6 +147,16 @@ description: ""

{{< proto/message message="GatewayIdentifiers" >}}

{{< proto/message package="tti.lorawan.v3" message="GetArsConfigurationRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="GetArsConfigurationResponse" >}}

{{< proto/message package="tti.lorawan.v3" message="GetAlertNotificationProfileRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="GetDefaultAlertNotificationProfileRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="GetAlertNotificationReceiverRequest" >}}

{{< proto/message message="GetIsConfigurationRequest" >}}

{{< proto/message message="GetIsConfigurationRequest" >}}
Expand All @@ -107,6 +167,10 @@ description: ""

{{< proto/message message="ListOAuthAccessTokensRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="ListAlertNotificationProfilesRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="ListAlertNotificationReceiversRequest" >}}

{{< proto/message message="OAuthAccessToken" >}}

{{< proto/message message="OAuthAccessTokenIdentifiers" >}}
Expand All @@ -131,6 +195,10 @@ description: ""

{{< proto/message message="SearchAccountsResponse" >}}

{{< proto/message package="tti.lorawan.v3" message="UpdateAlertNotificationProfileRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="UpdateAlertNotificationReceiverRequest" >}}

<!-- ## Enums -->

{{< proto/enum enum="ContactMethod" >}}
Expand Down
6 changes: 6 additions & 0 deletions doc/content/reference/api/network_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ description: ""

{{< proto/message message="RelaySecondChannel" >}}

{{< proto/message message="RelaySettings" >}}

{{< proto/message message="RelayUplinkForwardLimits" >}}

{{< proto/message message="RelayForwardLimits" >}}
Expand All @@ -181,8 +183,12 @@ description: ""

{{< proto/message message="RxMetadata" >}}

{{< proto/message message="ServedRelaySettings" >}}

{{< proto/message message="ServedRelayParameters" >}}

{{< proto/message message="ServingRelaySettings" >}}

{{< proto/message message="ServingRelayParameters" >}}

{{< proto/message message="RelayUplinkForwardingRule" >}}
Expand Down
4 changes: 4 additions & 0 deletions doc/content/reference/api/tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ Unlike the other services, the tenant services do **not** accept API keys or OAu

{{< proto/message package="tti.lorawan.v3" message="BatchGetTenantRegistryTotalsRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.AlertRoutingServer" >}}

{{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.AlertRoutingServer.Routing" >}}

{{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.IdentityServer.ApplicationLimits" >}}

{{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.IdentityServer.OrganizationLimits" >}}
Expand Down
20 changes: 20 additions & 0 deletions doc/content/the-things-stack/host/aws/ecs/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,26 @@ All meaningful changes to templates are documented in this file.

## Unreleased

## 3.29.0

### `2-1-db-aurora-master`, `2-2-db-aurora-replica`

- Update the default database engine version to `13.8`.
- Engine versions `14`, `15` and `16` are now supported.

### `2-5-db-timescale`

- Updated the default `node_exporter` version to `1.7.0`.
- Updated the default `postgres_exporter` version to `1.5.0`.
- Extension version `2.13.1` is now supported.
- Engine version `16` is now supported, but note that this requires an extension version of at least `2.13.1`.
- The default extension version is now `2.10.1`.
- The default engine version is now `15`.

### `5-4-ecs-cluster`

- Updated the default `node_exporter` version to `1.7.0`.

## 3.28.2

### Proxy
Expand Down
3 changes: 3 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ The Things Industries Command-line Interface

### SEE ALSO

* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL)
* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL)
* [ttn-lw-cli applications]({{< relref "ttn-lw-cli_applications" >}}) - Application commands
* [ttn-lw-cli authentication-providers]({{< relref "ttn-lw-cli_authentication-providers" >}}) - Authentication Provider commands
* [ttn-lw-cli clients]({{< relref "ttn-lw-cli_clients" >}}) - Client commands
Expand All @@ -61,6 +63,7 @@ The Things Industries Command-line Interface
* [ttn-lw-cli notifications]({{< relref "ttn-lw-cli_notifications" >}}) - Manage notifications
* [ttn-lw-cli organizations]({{< relref "ttn-lw-cli_organizations" >}}) - Organization commands
* [ttn-lw-cli packetbroker]({{< relref "ttn-lw-cli_packetbroker" >}}) - Packet Broker commands
* [ttn-lw-cli relays]({{< relref "ttn-lw-cli_relays" >}}) - Relay commands (EXPERIMENTAL)
* [ttn-lw-cli simulate]({{< relref "ttn-lw-cli_simulate" >}}) - Simulation commands
* [ttn-lw-cli templates]({{< relref "ttn-lw-cli_templates" >}}) - End Device template commands
* [ttn-lw-cli tenants]({{< relref "ttn-lw-cli_tenants" >}}) - Tenant commands
Expand Down
62 changes: 62 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "ttn-lw-cli alert-notification-profiles"
slug: ttn-lw-cli_alert-notification-profiles
---

## ttn-lw-cli alert-notification-profiles

Alert Notification Profile commands (EXPERIMENTAL)

### Options

```
-h, --help help for alert-notification-profiles
```

### Options inherited from parent commands

```
--allow-unknown-hosts Allow sending credentials to unknown hosts
--application-server-enabled Application Server enabled (default true)
--application-server-grpc-address string Application Server address (default "localhost:8884")
--ca string CA certificate file
-c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml])
--credentials-id string Credentials ID (if using multiple configurations)
--device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884")
--device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884")
--dump-requests When log level is set to debug, also dump request payload as JSON
--experimental.features strings Experimental features to activate
--gateway-server-enabled Gateway Server enabled (default true)
--gateway-server-grpc-address string Gateway Server address (default "localhost:8884")
--identity-server-grpc-address string Identity Server address (default "localhost:8884")
--input-format string Input format (default "json")
--insecure Connect without TLS
--join-server-enabled Join Server enabled (default true)
--join-server-grpc-address string Join Server address (default "localhost:8884")
--log.format string Log format to write (console, json) (default "console")
--log.level string The minimum level log messages must have to be shown (default "info")
--network-server-enabled Network Server enabled (default true)
--network-server-grpc-address string Network Server address (default "localhost:8884")
--oauth-server-address string OAuth Server address (default "https://localhost/oauth")
--output-format string Output format (default "json")
--packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884")
--qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884")
--retry.default-timeout duration Default timeout between retry attempts (default 100ms)
--retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true)
--retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts
--retry.max uint Maximum amount of times that a request can be reattempted
--skip-version-check Do not perform version checks
--telemetry.enable Enables telemetry for CLI (default true)
--telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect")
```

### SEE ALSO

* [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface
* [ttn-lw-cli alert-notification-profiles create]({{< relref "ttn-lw-cli_alert-notification-profiles_create" >}}) - Create an alert notification profile (EXPERIMENTAL)
* [ttn-lw-cli alert-notification-profiles delete]({{< relref "ttn-lw-cli_alert-notification-profiles_delete" >}}) - Delete an alert notification profile (EXPERIMENTAL)
* [ttn-lw-cli alert-notification-profiles get]({{< relref "ttn-lw-cli_alert-notification-profiles_get" >}}) - Get an alert notification profile (EXPERIMENTAL)
* [ttn-lw-cli alert-notification-profiles get-default]({{< relref "ttn-lw-cli_alert-notification-profiles_get-default" >}}) - Get default alert notification profile (EXPERIMENTAL)
* [ttn-lw-cli alert-notification-profiles list]({{< relref "ttn-lw-cli_alert-notification-profiles_list" >}}) - List alert notification profiles (EXPERIMENTAL)
* [ttn-lw-cli alert-notification-profiles update]({{< relref "ttn-lw-cli_alert-notification-profiles_update" >}}) - Update an alert notification profile (EXPERIMENTAL)

Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: "ttn-lw-cli alert-notification-profiles create"
slug: ttn-lw-cli_alert-notification-profiles_create
---

## ttn-lw-cli alert-notification-profiles create

Create an alert notification profile (EXPERIMENTAL)

```
ttn-lw-cli alert-notification-profiles create [profile-id] [flags]
```

### Options

```
--description string
-h, --help help for create
--ids.profile-id string
--is-default
--name string
--profile-id string
--receivers-ids strings set profile receiver IDs
```

### Options inherited from parent commands

```
--allow-unknown-hosts Allow sending credentials to unknown hosts
--application-server-enabled Application Server enabled (default true)
--application-server-grpc-address string Application Server address (default "localhost:8884")
--ca string CA certificate file
-c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml])
--credentials-id string Credentials ID (if using multiple configurations)
--device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884")
--device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884")
--dump-requests When log level is set to debug, also dump request payload as JSON
--experimental.features strings Experimental features to activate
--gateway-server-enabled Gateway Server enabled (default true)
--gateway-server-grpc-address string Gateway Server address (default "localhost:8884")
--identity-server-grpc-address string Identity Server address (default "localhost:8884")
--input-format string Input format (default "json")
--insecure Connect without TLS
--join-server-enabled Join Server enabled (default true)
--join-server-grpc-address string Join Server address (default "localhost:8884")
--log.format string Log format to write (console, json) (default "console")
--log.level string The minimum level log messages must have to be shown (default "info")
--network-server-enabled Network Server enabled (default true)
--network-server-grpc-address string Network Server address (default "localhost:8884")
--oauth-server-address string OAuth Server address (default "https://localhost/oauth")
--output-format string Output format (default "json")
--packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884")
--qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884")
--retry.default-timeout duration Default timeout between retry attempts (default 100ms)
--retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true)
--retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts
--retry.max uint Maximum amount of times that a request can be reattempted
--skip-version-check Do not perform version checks
--telemetry.enable Enables telemetry for CLI (default true)
--telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect")
```

### SEE ALSO

* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL)

Loading
Loading