Skip to content

Commit

Permalink
Add description how to disable blob usage (#1383)
Browse files Browse the repository at this point in the history
* doc: Add description how to disable blob usage

* doc: Rewrite the description of disabling blob
  • Loading branch information
halimi authored Oct 9, 2024
1 parent 1b39955 commit be8c65a
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ We use [Azure Database for PostgreSQL](https://learn.microsoft.com/en-us/azure/p

Azure offers a managed [Azure Cache for Redis Database](https://azure.microsoft.com/en-us/products/cache) service, but due to it's version not being compatible with {{% tts %}} the Redis we use is in-cluster. The newest Redis version supported by Azure Cache is 6.0, while the minimum required version of Redis for {{% tts %}} is 6.2.

User uploads of profile pictures and end device pictures are stored in public Azure Storage Containers.
User uploads of profile pictures and end device pictures are stored in public Azure Storage Containers (Optional).

## Configuration

The Azure Kubernetes deployment of {{% tts %}} uses a combination of configuration stored as Terraform and Helm configuration files.

The configuration for interoperability with other LoRaWAN Backend Interfaces-compliant servers is stored as multiple files in a private Azure Storage Account.
The configuration for interoperability with other LoRaWAN Backend Interfaces-compliant servers is stored as multiple files in a private Azure Storage Account (Optional).
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ global:
adminUserID: # User ID for the Administrator of the tenant. Do not use `admin`.
adminEmail: # Email of the Administrator of the tenant.
blob:
provider: "aws", "azure", "gcp" or "local"
provider: # "aws", "azure", "gcp", "local" or empty string to disable blob usage
aws: # Set only if provider is "aws".
region: # region
accessKeyID: # AWS access key ID
Expand Down Expand Up @@ -65,6 +65,9 @@ global:
tenancy:
adminKey: # See preparation section.
interop:
# Description: Interoperability configuration source.
# Expected value: "blob", "directory", "url" or empty string to disable blob usage
configSource: "blob"
blob:
# Description: Bucket for interoperability configuration.
# Expected value: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Copy each generated secret to a local file and then transfer those values later
| PProf Password | Password to access profiling (pprof) | 16 | `global.http.pprof.password` |
| Console Oauth Secret | Secret used by the Console to connect to The Things Stack | 16 | `global.console.oauth.clientSecret` |
| Tenant Administration Key | Secret used to administer cluster tenants | 32 | `global.tenancy.adminKey` |
| NOC Grafana Admin Password (optional) | Grafana admin password for The Things Stack Network Operations Center | 24 | `noc.grafana.adminPassword` |
| NOC Oauth Client Secret (optional) | OAuth client secret for The Things Stack Network Operations Center | 24 | `noc.oauth.clientSecret` |
| NOC Grafana Admin Password (optional) | Grafana admin password for The Things Stack Network Operations Center | 24 | `global.noc.grafana.adminPassword` |
| NOC Oauth Client Secret (optional) | OAuth client secret for The Things Stack Network Operations Center | 24 | `global.noc.oauth.clientSecret` |

The simplest option is to use `openssl`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ $ sudo chown -R 886:886 <blob>
2. Create the `edcs`, `interop`, `end_device_pictures` and `profile_pictures` folders at the root of the blob folder.
3. Create an empty `config.yml` in the `edcs` and `interop` folders.

##### Disabling Blob Storage

{{% tts %}} Helm Charts by default expects a blob storage configured but it is possible to use {{% tts %}} without it. You can disable the usage of blob by setting `global.interop.configSource` and `global.blob.provider` values to an empty string `""`.

#### 5. Traefik Proxy

The Things Stack Helm Charts currently only supports the [Traefik](https://traefik.io/traefik/) proxy out of the box to load balance incoming traffic.
Expand Down Expand Up @@ -229,9 +233,9 @@ The Things Stack expects the name of this secret to be set in the value `global.

The process of provisioning and maintenance of the certificate secret is left to the operator.

#### 7. (optional) TimescaleDB
#### 7. (Optional) TimescaleDB

Both {{% tts %}} [Storage Integration](https://www.thethingsindustries.com/docs/integrations/storage/) and {% tts %}} [Network Operations Center](https://www.thethingsindustries.com/docs/reference/components/network-operations-center/#accessing-network-operations-center) require a TimescaleDB instance.
Both {{% tts %}} [Storage Integration](https://www.thethingsindustries.com/docs/integrations/storage/) and {{% tts %}} [Network Operations Center](https://www.thethingsindustries.com/docs/reference/components/network-operations-center/#accessing-network-operations-center) require a TimescaleDB instance.

There can either be two separate TimeScaleDB instances or a single instance but different Databases.

Expand Down

0 comments on commit be8c65a

Please sign in to comment.