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

Release v3.31.1 documentation #1370

Merged
merged 2 commits into from
Aug 5, 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.30.2"
version = "3.31.1"

[markup]
[markup.goldmark]
Expand Down
4 changes: 4 additions & 0 deletions doc/content/api/reference/grpc/tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,10 @@ Unlike the other services, the tenant services do **not** accept API keys or OAu

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

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

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

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

{{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.IdentityServer.UserRegistration" >}}
Expand Down
10 changes: 10 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 @@ -8,6 +8,16 @@ All meaningful changes to templates are documented in this file.

## Unreleased

## 3.31.1

### Proxy

- Add `TenantAccess` grpc service and routes.

## 3.31.0

- Updated ECS AMIs to the latest versions.

## 3.30.2

- TimescaleDB replicas are now split to a separate template. Previously replicas had an ephemeral disk that needed to be copied when the replica was re-deployed. This made some upgrades really long to complete. Now the replicas are standalone and have their own disk that can be reattached to a new instance. This change should make upgrades faster and more reliable.
Expand Down
1 change: 1 addition & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ ttn-lw-cli tenants create [tenant-id] [flags]
--billing.provider.stripe.subscription-item-id string
--configuration.default-cluster.ars.routing.enabled
--configuration.default-cluster.as.webhooks.queue.enabled
--configuration.default-cluster.gs.mtls-authentication.client-ca-pool bytesBase64
--configuration.default-cluster.is.admin-rights.all
--configuration.default-cluster.is.email.network.branding-base-url string
--configuration.default-cluster.is.end-device-picture.disable-upload
Expand Down
3 changes: 3 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_tenants_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ ttn-lw-cli tenants get [tenant-id] [flags]
--configuration.default-cluster.as.webhooks select the configuration.default_cluster.as.webhooks field and all allowed sub-fields
--configuration.default-cluster.as.webhooks.queue select the configuration.default_cluster.as.webhooks.queue field and all allowed sub-fields
--configuration.default-cluster.as.webhooks.queue.enabled select the configuration.default_cluster.as.webhooks.queue.enabled field
--configuration.default-cluster.gs select the configuration.default_cluster.gs field and all allowed sub-fields
--configuration.default-cluster.gs.mtls-authentication select the configuration.default_cluster.gs.mtls_authentication field and all allowed sub-fields
--configuration.default-cluster.gs.mtls-authentication.client-ca-pool select the configuration.default_cluster.gs.mtls_authentication.client_ca_pool field
--configuration.default-cluster.is select the configuration.default_cluster.is field and all allowed sub-fields
--configuration.default-cluster.is.admin-rights select the configuration.default_cluster.is.admin_rights field and all allowed sub-fields
--configuration.default-cluster.is.admin-rights.all select the configuration.default_cluster.is.admin_rights.all field
Expand Down
3 changes: 3 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_tenants_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ ttn-lw-cli tenants list [flags]
--configuration.default-cluster.as.webhooks select the configuration.default_cluster.as.webhooks field and all allowed sub-fields
--configuration.default-cluster.as.webhooks.queue select the configuration.default_cluster.as.webhooks.queue field and all allowed sub-fields
--configuration.default-cluster.as.webhooks.queue.enabled select the configuration.default_cluster.as.webhooks.queue.enabled field
--configuration.default-cluster.gs select the configuration.default_cluster.gs field and all allowed sub-fields
--configuration.default-cluster.gs.mtls-authentication select the configuration.default_cluster.gs.mtls_authentication field and all allowed sub-fields
--configuration.default-cluster.gs.mtls-authentication.client-ca-pool select the configuration.default_cluster.gs.mtls_authentication.client_ca_pool field
--configuration.default-cluster.is select the configuration.default_cluster.is field and all allowed sub-fields
--configuration.default-cluster.is.admin-rights select the configuration.default_cluster.is.admin_rights field and all allowed sub-fields
--configuration.default-cluster.is.admin-rights.all select the configuration.default_cluster.is.admin_rights.all field
Expand Down
3 changes: 3 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_tenants_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ ttn-lw-cli tenants search [flags]
--configuration.default-cluster.as.webhooks select the configuration.default_cluster.as.webhooks field and all allowed sub-fields
--configuration.default-cluster.as.webhooks.queue select the configuration.default_cluster.as.webhooks.queue field and all allowed sub-fields
--configuration.default-cluster.as.webhooks.queue.enabled select the configuration.default_cluster.as.webhooks.queue.enabled field
--configuration.default-cluster.gs select the configuration.default_cluster.gs field and all allowed sub-fields
--configuration.default-cluster.gs.mtls-authentication select the configuration.default_cluster.gs.mtls_authentication field and all allowed sub-fields
--configuration.default-cluster.gs.mtls-authentication.client-ca-pool select the configuration.default_cluster.gs.mtls_authentication.client_ca_pool field
--configuration.default-cluster.is select the configuration.default_cluster.is field and all allowed sub-fields
--configuration.default-cluster.is.admin-rights select the configuration.default_cluster.is.admin_rights field and all allowed sub-fields
--configuration.default-cluster.is.admin-rights.all select the configuration.default_cluster.is.admin_rights.all field
Expand Down
1 change: 1 addition & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_tenants_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ ttn-lw-cli tenants update [tenant-id] [flags]
--billing.provider.stripe.subscription-item-id string
--configuration.default-cluster.ars.routing.enabled
--configuration.default-cluster.as.webhooks.queue.enabled
--configuration.default-cluster.gs.mtls-authentication.client-ca-pool bytesBase64
--configuration.default-cluster.is.admin-rights.all
--configuration.default-cluster.is.email.network.branding-base-url string
--configuration.default-cluster.is.end-device-picture.disable-upload
Expand Down
18 changes: 18 additions & 0 deletions doc/content/whats-new/3.31.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
date: 2024-08-05T09:19:00Z
title: "3.31.1"
featured:
{
added:
[
The Things Stack Cloud Plus subscription now includes gateway outage alerting and webhook retry features.,
],
changed:
[Gateway ID and device ID are not autogenerated and prefilled anymore.],
fixed: [],
}
---

### Changed

- Gateway ID and device ID are not autogenerated and prefilled anymore.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: ApplicationEventForwardCount
fields:
- name: time
message:
package: google.protobuf
name: Timestamp
rules:
required: true
default: "0001-01-01T00:00:00Z"
- name: count
comment: Application Server forwarded events count per event name.
map_key:
type: string
map_value:
type: uint64
default: {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: ApplicationEventsForwardCount
fields:
- name: event_forward_count
repeated:
message:
name: ApplicationEventForwardCount
default: []
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: ApplicationWebhookFailureByStatusCodeCount
fields:
- name: time
message:
package: google.protobuf
name: Timestamp
rules:
required: true
default: "0001-01-01T00:00:00Z"
- name: totals
map_key:
type: uint32
map_value:
type: uint64
default: {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: ApplicationWebhookFailureCount
fields:
- name: time
message:
package: google.protobuf
name: Timestamp
rules:
required: true
default: "0001-01-01T00:00:00Z"
- name: total
type: uint64
default: 0
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name: ApplicationWebhookFailureToForwardRatio
fields:
- name: webhook_failure_to_forward_ratio
type: float
default: 0
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: ApplicationWebhookFailuresByStatusCodeCount
fields:
- name: counts
repeated:
message:
name: ApplicationWebhookFailureByStatusCodeCount
default: []
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: ApplicationWebhookFailuresCount
fields:
- name: webhook_failure
repeated:
message:
name: ApplicationWebhookFailureCount
default: []
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: Configuration.Cluster.GatewayServer.MTLSAuthentication
fields:
- name: client_ca_pool
comment: PEM encoded pool of X.509 root certificates to trust for verifying the
presented TLS client certificate.
type: bytes
default: ""
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: Configuration.Cluster.GatewayServer
fields:
- name: mtls_authentication
message:
name: Configuration.Cluster.GatewayServer.MTLSAuthentication
default: {}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ fields:
message:
name: Configuration.Cluster.IdentityServer
default: {}
- name: gs
comment: Gateway Server configuration.
message:
name: Configuration.Cluster.GatewayServer
default: {}
- name: ns
message:
name: Configuration.Cluster.NetworkServer
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: ResendAdminValidationRequest
fields:
- name: tenant_ids
message:
name: TenantIdentifiers
rules:
required: true
default: {}
36 changes: 36 additions & 0 deletions doc/data/api/tti.lorawan.v3/services/Noc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,42 @@ methods:
http:
- method: POST
path: /noc/application/{application_ids.application_id}/data_rates/packet-count
QueryApplicationEventForwardCount:
name: QueryApplicationEventForwardCount
input:
name: ApplicationTimeBucketQuery
output:
name: ApplicationEventsForwardCount
http:
- method: POST
path: /noc/application/{application_ids.application_id}/events/forward
QueryApplicationWebhookFailure:
name: QueryApplicationWebhookFailure
input:
name: ApplicationTimeBucketQuery
output:
name: ApplicationWebhookFailuresCount
http:
- method: POST
path: /noc/application/{application_ids.application_id}/events/webhook/failure
QueryApplicationWebhookFailureTopFive:
name: QueryApplicationWebhookFailureTopFive
input:
name: ApplicationTimeBucketQuery
output:
name: ApplicationWebhookFailuresByStatusCodeCount
http:
- method: POST
path: /noc/application/{application_ids.application_id}/events/webhook/failure/top-five
QueryApplicationWebhookFailureToForwardRatio:
name: QueryApplicationWebhookFailureToForwardRatio
input:
name: ApplicationTimeWindowQuery
output:
name: ApplicationWebhookFailureToForwardRatio
http:
- method: POST
path: /noc/application/{application_ids.application_id}/events/webhook/failure/ratio
QueryEndDevicesActive:
name: QueryEndDevicesActive
input:
Expand Down
12 changes: 12 additions & 0 deletions doc/data/api/tti.lorawan.v3/services/TenantAccess.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: TenantAccess
methods:
ResendAdminValidation:
name: ResendAdminValidation
input:
name: ResendAdminValidationRequest
output:
package: google.protobuf
name: Empty
http:
- method: POST
path: /tenants/{tenant_ids.tenant_id}/resend-admin-validation
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@ name: GatewayToken.Payload
fields:
- name: gateway_ids
message:
package: ttn.lorawan.v3
name: GatewayIdentifiers
default: {}
- name: rights
message:
package: ttn.lorawan.v3
name: Rights
default: {}
- name: created_at
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: IsConfiguration.TenantRegistration.ContactInfoValidation
fields:
- name: token_ttl
message:
package: google.protobuf
name: Duration
default: 0s
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: IsConfiguration.TenantRegistration
fields:
- name: contact_info_validation
message:
name: IsConfiguration.TenantRegistration.ContactInfoValidation
default: {}
4 changes: 4 additions & 0 deletions doc/data/api/ttn.lorawan.v3/messages/IsConfiguration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,7 @@ fields:
message:
name: IsConfiguration.CollaboratorRights
default: {}
- name: tenant_registration
message:
name: IsConfiguration.TenantRegistration
default: {}
Loading
Loading