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 Server Address mismatch error when using TTS CLI #1309

Conversation

Siva-7482
Copy link
Contributor

Summary

Adding the error error:cmd/ttn-lw-cli/commands:end_device_server_address_mismatch (Network/Application/Join Server address mismatch) to the Troubleshooting CLI documentation.

#1302

Screenshots

New Section:

image

Changes

  • Added the Server Address mismatch error when using The Things Stack CLI.

Notes for Reviewers

...

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links. Test with HUGO_PARAMS_SEARCH_ENABLED=true if style changes will affect the search bar.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

Comment on lines 108 to 110
Accessing {{% tts %}} CLI requires the correct [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}) with the server addresses. If you try to perform actions on the entities registered in other server address, then you will face the error `error:cmd/ttn-lw-cli/commands:end_device_server_address_mismatch`.

For example, if you configured the CLI with the `eu1` cluster server address and try to access the device registered on the `au1` cluster, then the below error will be observed due to the mismatch of server addresses in the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Accessing {{% tts %}} CLI requires the correct [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}) with the server addresses. If you try to perform actions on the entities registered in other server address, then you will face the error `error:cmd/ttn-lw-cli/commands:end_device_server_address_mismatch`.
For example, if you configured the CLI with the `eu1` cluster server address and try to access the device registered on the `au1` cluster, then the below error will be observed due to the mismatch of server addresses in the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}).
If you [configure {{% tts %}} CLI]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}) to use one cluster server address (for example `eu1`) and try to perform actions on the entities registered in other cluster (for example `au1`), you will probably face the following error:

error:cmd/ttn-lw-cli/commands:end_device_server_address_mismatch (Network/Application/Join Server address mismatch)
```

While configuring the server address in the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}), you need to ensure that the correct cluster address is used for performing any operations on entities registered in that cluster. If you want to perform operations on the entities registered in the `eu1` cluster then you need to ensure the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}) with the `eu1` cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
While configuring the server address in the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}), you need to ensure that the correct cluster address is used for performing any operations on entities registered in that cluster. If you want to perform operations on the entities registered in the `eu1` cluster then you need to ensure the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}) with the `eu1` cluster.
If you want to perform operations on the entities registered in a certain cluster, then you need to ensure the CLI is configured with server addresses for that cluster.


While configuring the server address in the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}), you need to ensure that the correct cluster address is used for performing any operations on entities registered in that cluster. If you want to perform operations on the entities registered in the `eu1` cluster then you need to ensure the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}) with the `eu1` cluster.

It is important to use the `eu1` cluster as the Identity Server address in the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}), regardless of the entity registered in any other cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It is important to use the `eu1` cluster as the Identity Server address in the [CLI configuration file]({{< ref "/the-things-stack/interact/cli/configuring-cli" >}}), regardless of the entity registered in any other cluster.
Keep in mind that Identity Server and OAuth addresses are always in `eu1` cluster, as described [here]({{< ref "/the-things-stack/cloud/addresses#command-line-interface" >}}).

@Siva-7482 Siva-7482 force-pushed the doc/troubleshoot-cli-add branch from 66edaba to 3e9fbdd Compare April 11, 2024 09:59
@nejraselimovic nejraselimovic merged commit c21bf15 into TheThingsIndustries:master Apr 21, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants