SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-07-27 16:32:34 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Route identity character limit increase #489

New Issue
Open
opened 2025-11-20 05:12:17 -05:00 by saavagebueno · 5 comments
saavagebueno commented 2025-11-20 05:12:17 -05:00
Owner
Copy Link

Originally created by @kent-hydra on GitHub (Oct 28, 2023).

Is your feature request related to a problem? Please describe.
Attempting to use Netbird with a multi-tenant / multi-regional architecture, so having the network routes named with enough identifying information is essential. Currently naming looks something like "Company ABC - Region A - Group 1 - Management" which would put us over the character limit and return an error such as {"message":"identifier should be between 1 and 40","code":422}

Describe the solution you'd like
Increase in the number of characters allowed for network_id on the routes objects.

Describe alternatives you've considered
We considered slimming it down by using slugs. This may work in the short term, but 40 characters is not very much and we may still run into the limits later on depending on org/region names. Its also not as pretty.

Originally created by @kent-hydra on GitHub (Oct 28, 2023). **Is your feature request related to a problem? Please describe.** Attempting to use Netbird with a multi-tenant / multi-regional architecture, so having the network routes named with enough identifying information is essential. Currently naming looks something like "Company ABC - Region A - Group 1 - Management" which would put us over the character limit and return an error such as `{"message":"identifier should be between 1 and 40","code":422}` **Describe the solution you'd like** Increase in the number of characters allowed for `network_id` on the routes objects. **Describe alternatives you've considered** We considered slimming it down by using slugs. This may work in the short term, but 40 characters is not very much and we may still run into the limits later on depending on org/region names. Its also not as pretty.
saavagebueno commented 2025-11-20 05:12:17 -05:00
Author
Owner
Copy Link

@mlsmaycon commented on GitHub (Oct 29, 2023):

Hello @kent-hydra, currently, we are limiting to 40 characters only in the network ID, but for the description have 255 characters, would it be better option for you to use slugs for network_id and full names in the description?

@mlsmaycon commented on GitHub (Oct 29, 2023): Hello @kent-hydra, currently, we are limiting to 40 characters only in the network ID, but for the description have 255 characters, would it be better option for you to use slugs for network_id and full names in the description?
saavagebueno commented 2025-11-20 05:12:17 -05:00
Author
Owner
Copy Link

@kent-hydra commented on GitHub (Nov 5, 2023):

Ah I do see the description field when creating routes, although I do not see it when viewing in the UI. This could potentially work if it was visible.

image

@kent-hydra commented on GitHub (Nov 5, 2023): Ah I do see the description field when creating routes, although I do not see it when viewing in the UI. This could potentially work if it was visible. ![image](https://github.com/netbirdio/netbird/assets/120897091/7dfc341e-7e30-4231-9ce9-459347846363)
saavagebueno commented 2025-11-20 05:12:18 -05:00
Author
Owner
Copy Link

@kent-hydra commented on GitHub (Feb 19, 2025):

Hello @mlsmaycon ,
We ended up using the description as mentioned before. The description was a good solution for the UI. In the CLI when we started using the routing feature to handle overlapping routes it became an issue. How we handled it was using an internal ID for the name and the description was the human readable name. In the CLI without the description it is hard for us to tell what route is what. Would it be possible to add the description to the CLI output?

Image
@kent-hydra commented on GitHub (Feb 19, 2025): Hello @mlsmaycon , We ended up using the description as mentioned before. The description was a good solution for the UI. In the CLI when we started using the routing feature to handle overlapping routes it became an issue. How we handled it was using an internal ID for the name and the description was the human readable name. In the CLI without the description it is hard for us to tell what route is what. Would it be possible to add the description to the CLI output? <img width="333" alt="Image" src="https://github.com/user-attachments/assets/bee81a64-1ad4-4976-81a0-777cbe6c7d3d" />
saavagebueno commented 2025-11-20 05:12:18 -05:00
Author
Owner
Copy Link

@mlsmaycon commented on GitHub (Feb 19, 2025):

@kent-hydra, thanks for the update. I will discuss this with the team regarding concerns, but we can probably make this an option account setting.

Also, we've recently released the Networks concept, where you can use a resource with a name of up to 100 characters, and it works similarly to Network routes.

You can learn more in the following links:

@mlsmaycon commented on GitHub (Feb 19, 2025): @kent-hydra, thanks for the update. I will discuss this with the team regarding concerns, but we can probably make this an option account setting. Also, we've recently released the Networks concept, where you can use a resource with a name of up to 100 characters, and it works similarly to Network routes. You can learn more in the following links: - https://docs.netbird.io/how-to/networks - https://docs.netbird.io/how-to/routing-traffic-to-multiple-resources
saavagebueno commented 2025-11-20 05:12:18 -05:00
Author
Owner
Copy Link

@kent-hydra commented on GitHub (Feb 19, 2025):

Thank you @mlsmaycon , we will look into these options

@kent-hydra commented on GitHub (Feb 19, 2025): Thank you @mlsmaycon , we will look into these options
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#489
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?