Skip to content

Commit

Permalink
Merge pull request #291 from quixio/tonybedford/sc-55822/update-strea…
Browse files Browse the repository at this point in the history
…ming-token-topic

Update Streaming Token topic
  • Loading branch information
tbedford authored Apr 2, 2024
2 parents 3e9ae3a + 41e203c commit 924dc6b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/apis/portal-api/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Portal API
description: The Portal API gives access to the Portal interface, enabling you to programmatically control projects, environments, applications, and deployments.
description: The Portal API gives access to the Portal interface.
---

# Overview
Expand Down
1 change: 0 additions & 1 deletion docs/develop/authentication/quix-streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ If you're using Quix Streams for local development, you'll need to set some envi

```
Quix__Sdk__Token="sdk-12345"
Quix__Portal__Api="portal-api.platform.quix.io"
```

You can read the documentation on [obtaining your SDK token](./streaming-token.md), also known as the streaming token.
Expand Down
6 changes: 3 additions & 3 deletions docs/develop/authentication/streaming-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you are looking for a bearer token to access the Quix APIs, such as the Porta

The streaming token is primarily used to authenticate the [Quix Streams client library](https://quix.io/docs/quix-streams/introduction.html).

When using it with `QuixStreamingClient`, you no longer need to provide all broker credentials manually, they’ll be acquired when needed and set up automatically.
When using Quix Streams in Quix Cloud, you no longer need to provide all broker credentials manually, they’ll be acquired when needed and set up automatically.

!!! warning

Expand All @@ -28,9 +28,9 @@ Having two keys lets you update your services without interruption, as both `Tok

You have two main options regarding how you rotate:

1. The easiest way to rotate comes with some service downtime. This assumes you do not directly set the token for your `QuixStreamingClient`, instead you let Quix take care of it for you by using the default environment variable. In this scenario all you have to do is rotate keys, stop and start all your deployments. Until a service is restarted it’ll try to communicate with Quix using the deactivated token. If you’re using local environments, those need to be updated manually.
1. The easiest way to rotate comes with some service downtime. This assumes you do not directly set the token for your Quix Streams code, instead you let Quix take care of it for you by using the default environment variable. In this scenario all you have to do is rotate keys, stop and start all your deployments. Until a service is restarted it’ll try to communicate with Quix using the deactivated token. If you’re using local environments, those need to be updated manually.

2. The alternative option is more complicated, but you can achieve no downtime. This requires you to set a new environment variable you control. This should point to the token to be used. Provide the value of this environment variable to `QuixStreamingClient` by passing it as an argument. Once you have that, set the value of this environment variable to `Token 2` and start your services. When you’re sure you replaced the tokens for all services, rotate your keys.
2. The alternative option is more complicated, but you can achieve no downtime. This requires you to set a new environment variable you control. This should point to the token to be used. Provide the value of this environment variable to your Quix Streams code by passing it as an argument. Once you have that, set the value of this environment variable to `Token 2` and start your services. When you’re sure you replaced the tokens for all services, rotate your keys.

!!! note

Expand Down

0 comments on commit 924dc6b

Please sign in to comment.