doc: Add v3.24.0 release docs (#1036)

TheThingsIndustries · Feb 19, 2023 · 4e78b82 · 4e78b82
1 parent f8654b0
commit 4e78b82
Show file tree

Hide file tree

Showing 55 changed files with 720 additions and 103 deletions.
diff --git a/doc/config/_default/config.toml b/doc/config/_default/config.toml
@@ -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.23.2"
+  version = "3.24.0"
 
 [markup]
   [markup.goldmark]

diff --git a/doc/content/getting-started/aws/ecs/changelog/index.md b/doc/content/getting-started/aws/ecs/changelog/index.md
@@ -8,6 +8,65 @@ All meaningful changes to templates are documented in this file.
 
 ## Unreleased
 
+## 3.24.0
+
+### ECS templates
+
+- Support for TLS mutual authentication terminated by The Things Stack has been removed. TLS authentication is now only terminated by the Network Load Balancer or Envoy Proxy.
+- Support for LoRaWAN Backend Interfaces interoperability with the Join Server has been removed.
+- Crypto Server deployment has been removed.
+
+### Upgrade procedure
+
+- As this version upgrade removes certain resources, the standard upgrade procedure which follows the template numbering order cannot be followed directly.
+- The `5-7a-certs-le` template needs to be upgraded first.
+- The `5-3a-ecs-is-service` template needs to be upgraded next, and have `InteropEnabled` set to `disabled`. The value may be enabled again after every other template has been upgraded.
+- The standard upgrade procedure can commence after these two templates have been upgraded.
+
+### `3-2-load-balancer-rules`
+
+- Changed `InteropEnabled` to a boolean since TLS mutual authentication is no longer terminated by The Things Stack.
+  - If you were using `server-authentication` or `mutual-authentication`, select `true`;
+  - If you were using `disabled`, select `false`.
+
+### `4-1-secrets`
+
+- Removed `InteropTLSSecret` and output `InteropTLSSecretID`.
+
+### `4-2a-configuration`
+
+- Removed `InteropEnabled` parameter.
+- Removed `CryptoServerDNSName` parameter.
+- Added `CertificateAuthorityARN` parameter.
+
+### `5-2-ecs-ops`
+
+- Added `UseCertificateAuthorityARN` parameter.
+
+### `5-3a-ecs-is-service`
+
+- Changed `InteropEnabledIS` to a boolean since TLS mutual authentication is no longer terminated by The Things Stack.
+  - If you were using `server-authentication` or `mutual-authentication`, select `true`;
+  - If you were using `disabled`, select `false`.
+- Added `UseCertificateAuthorityARN` parameter.
+
+### `5-3c-ecs-tbs-service`
+
+- Added `UseCertificateAuthorityARN` parameter.
+
+### `5-4-ecs-services`
+
+- Removed `InteropEnabledJS` parameter.
+- Added `UseCertificateAuthorityARN` parameter.
+
+### `5-7a-certs-le`
+
+- Removed configuration for storing certificates for interoperability.
+
+### `200-1-crypto`
+
+- This template has been removed and can be undeployed.
+
 ## 3.23.2
 
 ## 3.23.1

diff --git a/doc/content/reference/api/end_device.md b/doc/content/reference/api/end_device.md
@@ -287,6 +287,8 @@ See the [EndDevice message](#message:EndDevice) and its sub-messages for additio
 
 {{< proto/message message="Location" >}}
 
+{{< proto/message message="LoRaAllianceProfileIdentifiers" >}}
+
 {{< proto/message message="LoRaDataRate" >}}
 
 {{< proto/message message="LRFHSSDataRate" >}}

diff --git a/doc/content/reference/api/network_operations_center.md b/doc/content/reference/api/network_operations_center.md
@@ -9,8 +9,6 @@ description: ""
 
 {{< proto/method package="tti.lorawan.v3" service="Noc" method="QueryGatewaysConnectivityTimes" >}}
 
-{{< proto/method package="tti.lorawan.v3" service="Noc" method="QueryGatewaysActive" >}}
-
 {{< proto/method package="tti.lorawan.v3" service="Noc" method="QueryGatewayConnectionEvents" >}}
 
 {{< proto/method package="tti.lorawan.v3" service="Noc" method="QueryGatewayChannelsUtilization" >}}
@@ -31,10 +29,6 @@ description: ""
 
 {{< proto/message package="tti.lorawan.v3" message="GatewayConnectionEventTypeValue" >}}
 
-{{< proto/message package="tti.lorawan.v3" message="GatewaysConnectedTimeBuckets" >}}
-
-{{< proto/message package="tti.lorawan.v3" message="GatewaysConnectedTimeBucket" >}}
-
 {{< proto/message package="tti.lorawan.v3" message="TimeBucketQuery" >}}
 
 {{< proto/message package="tti.lorawan.v3" message="TimeWindowQuery" >}}

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_storage_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_storage_get.md
@@ -180,9 +180,6 @@ ttn-lw-cli applications storage get [application-id] [flags]
       --up.uplink-message.version-ids.firmware-version                                      select the up.uplink_message.version_ids.firmware_version field
       --up.uplink-message.version-ids.hardware-version                                      select the up.uplink_message.version_ids.hardware_version field
       --up.uplink-message.version-ids.model-id                                              select the up.uplink_message.version_ids.model_id field
-      --up.uplink-message.version-ids.serial-number                                         select the up.uplink_message.version_ids.serial_number field
-      --up.uplink-message.version-ids.vendor-id                                             select the up.uplink_message.version_ids.vendor_id field
-      --up.uplink-message.version-ids.vendor-profile-id                                     select the up.uplink_message.version_ids.vendor_profile_id field
       --up.uplink-normalized                                                                select the up.uplink_normalized field and all allowed sub-fields
       --up.uplink-normalized.confirmed                                                      select the up.uplink_normalized.confirmed field
       --up.uplink-normalized.consumed-airtime                                               select the up.uplink_normalized.consumed_airtime field
@@ -228,9 +225,6 @@ ttn-lw-cli applications storage get [application-id] [flags]
       --up.uplink-normalized.version-ids.firmware-version                                   select the up.uplink_normalized.version_ids.firmware_version field
       --up.uplink-normalized.version-ids.hardware-version                                   select the up.uplink_normalized.version_ids.hardware_version field
       --up.uplink-normalized.version-ids.model-id                                           select the up.uplink_normalized.version_ids.model_id field
-      --up.uplink-normalized.version-ids.serial-number                                      select the up.uplink_normalized.version_ids.serial_number field
-      --up.uplink-normalized.version-ids.vendor-id                                          select the up.uplink_normalized.version_ids.vendor_id field
-      --up.uplink-normalized.version-ids.vendor-profile-id                                  select the up.uplink_normalized.version_ids.vendor_profile_id field
 ```
 
 ### Options inherited from parent commands

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_create.md
@@ -246,6 +246,7 @@ ttn-lw-cli end-devices create [application-id] [device-id] [flags]
       --root-keys.app-key.key 16-bytes                                                        
       --root-keys.nwk-key.key 16-bytes                                                        
       --root-keys.root-key-id string                                                          
+      --serial-number string                                                                  
       --service-profile-id string                                                             
       --session.dev-addr 4-bytes                                                              
       --session.keys.app-s-key.key 16-bytes                                                   
@@ -269,8 +270,6 @@ ttn-lw-cli end-devices create [application-id] [device-id] [flags]
       --version-ids.firmware-version string                                                   
       --version-ids.hardware-version string                                                   
       --version-ids.model-id string                                                           
-      --version-ids.vendor-id uint32                                                          
-      --version-ids.vendor-profile-id uint32                                                  
       --with-claim-authentication-code                                                        generate claim authentication code of 4 bytes
       --with-root-keys                                                                        generate OTAA root keys
       --with-session                                                                          generate ABP session DevAddr and keys

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_get.md
@@ -46,6 +46,7 @@ ttn-lw-cli end-devices get [application-id] [device-id] [flags]
       --last-rj-count-1                                                                select the last_rj_count_1 field
       --last-seen-at                                                                   select the last_seen_at field
       --locations                                                                      select the locations field
+      --lora-alliance-profile-ids                                                      select the lora_alliance_profile_ids field and all allowed sub-fields
       --lorawan-phy-version                                                            select the lorawan_phy_version field
       --lorawan-version                                                                select the lorawan_version field
       --mac-settings                                                                   select the mac_settings field and all allowed sub-fields
@@ -289,6 +290,7 @@ ttn-lw-cli end-devices get [application-id] [device-id] [flags]
       --root-keys.nwk-key                                                              select the root_keys.nwk_key field and all allowed sub-fields
       --root-keys.nwk-key.key                                                          select the root_keys.nwk_key.key field
       --root-keys.root-key-id                                                          select the root_keys.root_key_id field
+      --serial-number                                                                  select the serial_number field
       --service-profile-id                                                             select the service_profile_id field
       --session                                                                        select the session field and all allowed sub-fields
       --session.dev-addr                                                               select the session.dev_addr field

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_list.md
@@ -29,11 +29,13 @@ ttn-lw-cli end-devices list [application-id] [flags]
       --last-seen-at                           select the last_seen_at field
       --limit uint32                           maximum number of results to get (default 50)
       --locations                              select the locations field
+      --lora-alliance-profile-ids              select the lora_alliance_profile_ids field and all allowed sub-fields
       --name                                   select the name field
       --network-server-address                 select the network_server_address field
       --order string                           order by this field
       --page uint32                            results page number (default 1)
       --picture                                select the picture field and all allowed sub-fields
+      --serial-number                          select the serial_number field
       --service-profile-id                     select the service_profile_id field
       --version-ids                            select the version_ids field and all allowed sub-fields
       --version-ids.band-id                    select the version_ids.band_id field

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_reset.md b/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_reset.md
@@ -46,6 +46,7 @@ ttn-lw-cli end-devices reset [application-id] [device-id] [flags]
       --last-rj-count-1                                                                select the last_rj_count_1 field
       --last-seen-at                                                                   select the last_seen_at field
       --locations                                                                      select the locations field
+      --lora-alliance-profile-ids                                                      select the lora_alliance_profile_ids field and all allowed sub-fields
       --lorawan-phy-version                                                            select the lorawan_phy_version field
       --lorawan-version                                                                select the lorawan_version field
       --mac-settings                                                                   select the mac_settings field and all allowed sub-fields
@@ -289,6 +290,7 @@ ttn-lw-cli end-devices reset [application-id] [device-id] [flags]
       --root-keys.nwk-key                                                              select the root_keys.nwk_key field and all allowed sub-fields
       --root-keys.nwk-key.key                                                          select the root_keys.nwk_key.key field
       --root-keys.root-key-id                                                          select the root_keys.root_key_id field
+      --serial-number                                                                  select the serial_number field
       --service-profile-id                                                             select the service_profile_id field
       --session                                                                        select the session field and all allowed sub-fields
       --session.dev-addr                                                               select the session.dev_addr field

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_search.md b/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_search.md
@@ -51,6 +51,7 @@ ttn-lw-cli end-devices search [application-id] [flags]
       --last-seen-at                                                                   select the last_seen_at field
       --limit uint32                                                                   
       --locations                                                                      select the locations field
+      --lora-alliance-profile-ids                                                      select the lora_alliance_profile_ids field and all allowed sub-fields
       --lorawan-phy-version                                                            select the lorawan_phy_version field
       --lorawan-version                                                                select the lorawan_version field
       --mac-settings                                                                   select the mac_settings field and all allowed sub-fields
@@ -298,6 +299,7 @@ ttn-lw-cli end-devices search [application-id] [flags]
       --root-keys.nwk-key                                                              select the root_keys.nwk_key field and all allowed sub-fields
       --root-keys.nwk-key.key                                                          select the root_keys.nwk_key.key field
       --root-keys.root-key-id                                                          select the root_keys.root_key_id field
+      --serial-number                                                                  select the serial_number field
       --service-profile-id                                                             select the service_profile_id field
       --session                                                                        select the session field and all allowed sub-fields
       --session.dev-addr                                                               select the session.dev_addr field

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_set.md
@@ -243,6 +243,7 @@ ttn-lw-cli end-devices set [application-id] [device-id] [flags]
       --root-keys.app-key.key 16-bytes                                                        
       --root-keys.nwk-key.key 16-bytes                                                        
       --root-keys.root-key-id string                                                          
+      --serial-number string                                                                  
       --service-profile-id string                                                             
       --session.dev-addr 4-bytes                                                              
       --session.keys.app-s-key.key 16-bytes                                                   
@@ -268,8 +269,6 @@ ttn-lw-cli end-devices set [application-id] [device-id] [flags]
       --version-ids.firmware-version string                                                   
       --version-ids.hardware-version string                                                   
       --version-ids.model-id string                                                           
-      --version-ids.vendor-id uint32                                                          
-      --version-ids.vendor-profile-id uint32                                                  
 ```
 
 ### Options inherited from parent commands

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_storage_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_storage_get.md
@@ -183,9 +183,6 @@ ttn-lw-cli end-devices storage get [application-id] [device-id] [flags]
       --up.uplink-message.version-ids.firmware-version                                      select the up.uplink_message.version_ids.firmware_version field
       --up.uplink-message.version-ids.hardware-version                                      select the up.uplink_message.version_ids.hardware_version field
       --up.uplink-message.version-ids.model-id                                              select the up.uplink_message.version_ids.model_id field
-      --up.uplink-message.version-ids.serial-number                                         select the up.uplink_message.version_ids.serial_number field
-      --up.uplink-message.version-ids.vendor-id                                             select the up.uplink_message.version_ids.vendor_id field
-      --up.uplink-message.version-ids.vendor-profile-id                                     select the up.uplink_message.version_ids.vendor_profile_id field
       --up.uplink-normalized                                                                select the up.uplink_normalized field and all allowed sub-fields
       --up.uplink-normalized.confirmed                                                      select the up.uplink_normalized.confirmed field
       --up.uplink-normalized.consumed-airtime                                               select the up.uplink_normalized.consumed_airtime field
@@ -231,9 +228,6 @@ ttn-lw-cli end-devices storage get [application-id] [device-id] [flags]
       --up.uplink-normalized.version-ids.firmware-version                                   select the up.uplink_normalized.version_ids.firmware_version field
       --up.uplink-normalized.version-ids.hardware-version                                   select the up.uplink_normalized.version_ids.hardware_version field
       --up.uplink-normalized.version-ids.model-id                                           select the up.uplink_normalized.version_ids.model_id field
-      --up.uplink-normalized.version-ids.serial-number                                      select the up.uplink_normalized.version_ids.serial_number field
-      --up.uplink-normalized.version-ids.vendor-id                                          select the up.uplink_normalized.version_ids.vendor_id field
-      --up.uplink-normalized.version-ids.vendor-profile-id                                  select the up.uplink_normalized.version_ids.vendor_profile_id field
 ```
 
 ### Options inherited from parent commands