extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-20 01:37:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

api-v1

Browse Source
This commit is contained in:
Michael Quigley 2025-02-26 12:04:51 -05:00
parent 6006410ae6
commit cfe8961745
No known key found for this signature in database
GPG Key ID: 9B60314A9DD20A62
10 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -20,6 +20,8 @@ FEATURE: `zrok test canary` CLI tree replaces the old `zrok test loop` tree; new
FEATURE: New `/api/v1/versions` endpoint to return comprehensive, full stack version information about the deployed service instance. Currently only returns a single `controllerVersion` property (https://github.com/openziti/zrok/issues/881) FEATURE: New `/api/v1/versions` endpoint to return comprehensive, full stack version information about the deployed service instance. Currently only returns a single `controllerVersion` property (https://github.com/openziti/zrok/issues/881)
CHANGE: The default API URL for `v1.0.x` zrok clients is now `https://api-v1.zrok.io` (instead of the older `https://api.zrok.io`). The zrok.io deployment will now be maintaining version-specific DNS for versioned API endpoints.
CHANGE: Refactored API implementation. Cleanup, lint removal, additional data elements added, unused data removed (https://github.com/openziti/zrok/issues/834) CHANGE: Refactored API implementation. Cleanup, lint removal, additional data elements added, unused data removed (https://github.com/openziti/zrok/issues/834)
CHANGE: Deprecated the `passwords` configuration stanza. The zrok controller and API console now use a hard-coded set of (what we believe to be) reasonable assumptions about password quality (https://github.com/openziti/zrok/issues/834) CHANGE: Deprecated the `passwords` configuration stanza. The zrok controller and API console now use a hard-coded set of (what we believe to be) reasonable assumptions about password quality (https://github.com/openziti/zrok/issues/834)

2
docs/guides/self-hosting/instance-configuration.mdx
View File

@ -9,7 +9,7 @@ This guide is relevant if you are self-hosting or using a friend's `zrok` instan
The `zrok` *command* on your computer uses a `zrok` *instance* over the network. The `zrok` *command* on your computer uses a `zrok` *instance* over the network.
The default instance API endpoint for the `zrok` command is `api.zrok.io`. Set the API endpoint to another instance's API endpoint: The default instance API endpoint for the `zrok` command is `api-v1.zrok.io`. Set the API endpoint to another instance's API endpoint:
```text ```text
zrok config set apiEndpoint https://zrok.example.com zrok config set apiEndpoint https://zrok.example.com

2
docs/guides/self-hosting/linux/index.mdx
View File

@ -117,7 +117,7 @@ See the separate guides on [configuring metrics](/guides/self-hosting/metrics-an
## Environment Variables ## Environment Variables
The `zrok` binaries are configured to work with the global `zrok.io` service, and default to using `api.zrok.io` as the endpoint for communicating with the service. The `zrok` binaries are configured to work with the global `zrok.io` service, and default to using `api-v1.zrok.io` as the endpoint for communicating with the service.
To work with a self-hosted `zrok` deployment, you'll need to set the `ZROK_API_ENDPOINT` environment variable to point to the address where your `zrok` controller will be listening, according to `endpoint` in the configuration file above. To work with a self-hosted `zrok` deployment, you'll need to set the `ZROK_API_ENDPOINT` environment variable to point to the address where your `zrok` controller will be listening, according to `endpoint` in the configuration file above.

2
environment/env_v0_3/api.go
View File

@ -62,7 +62,7 @@ func (r *Root) Client() (*rest_client_zrok.Zrok, error) {
} }
func (r *Root) ApiEndpoint() (string, string) { func (r *Root) ApiEndpoint() (string, string) {
apiEndpoint := "https://api.zrok.io" apiEndpoint := "https://api-v1.zrok.io"
from := "binary" from := "binary"
if r.Config() != nil && r.Config().ApiEndpoint != "" { if r.Config() != nil && r.Config().ApiEndpoint != "" {

2
environment/env_v0_4/api.go
View File

@ -61,7 +61,7 @@ func (r *Root) Client() (*rest_client_zrok.Zrok, error) {
} }
func (r *Root) ApiEndpoint() (string, string) { func (r *Root) ApiEndpoint() (string, string) {
apiEndpoint := "https://api.zrok.io" apiEndpoint := "https://api-v1.zrok.io"
from := "binary" from := "binary"
if r.Config() != nil && r.Config().ApiEndpoint != "" { if r.Config() != nil && r.Config().ApiEndpoint != "" {

2
nfpm/zrok-enable.bash
View File

@ -51,7 +51,7 @@ if [[ -z "${ZROK_ENABLE_TOKEN}" ]]; then
echo "ERROR: ZROK_ENABLE_TOKEN is not defined" >&2 echo "ERROR: ZROK_ENABLE_TOKEN is not defined" >&2
exit 1 exit 1
else else
zrok config set apiEndpoint "${ZROK_API_ENDPOINT:-https://api.zrok.io}" zrok config set apiEndpoint "${ZROK_API_ENDPOINT:-https://api-v1.zrok.io}"
echo "INFO: running: zrok enable ..." echo "INFO: running: zrok enable ..."
exec zrok enable --headless --description "${ZROK_ENVIRONMENT_NAME:-${DEFAULT_ZROK_ENVIRONMENT_NAME}}" "${ZROK_ENABLE_TOKEN}" exec zrok enable --headless --description "${ZROK_ENVIRONMENT_NAME:-${DEFAULT_ZROK_ENVIRONMENT_NAME}}" "${ZROK_ENABLE_TOKEN}"
fi fi

4
nfpm/zrok-share.env
View File

@ -20,7 +20,7 @@ ZROK_ENABLE_TOKEN=""
ZROK_ENVIRONMENT_NAME="" ZROK_ENVIRONMENT_NAME=""
# You MUST set this if not using the default API endpoint # You MUST set this if not using the default API endpoint
#ZROK_API_ENDPOINT="https://api.zrok.io" #ZROK_API_ENDPOINT="https://api-v1.zrok.io"
# #
## ZROK BACKEND MODE AND TARGET ## ZROK BACKEND MODE AND TARGET
@ -88,7 +88,7 @@ ZROK_TARGET="" # e.g., http://127.0.0.1:3000
# WARNING: changes take effect the next time the frontend URL is reserved # WARNING: changes take effect the next time the frontend URL is reserved
#ZROK_UNIQUE_NAME="" #ZROK_UNIQUE_NAME=""
# you MAY set one OAuth2/OIDC provider; "google" and "github" are valid for the default instance api.zrok.io # you MAY set one OAuth2/OIDC provider; "google" and "github" are valid for the default instance api-v1.zrok.io
# WARNING: changes take effect the next time the frontend URL is reserved # WARNING: changes take effect the next time the frontend URL is reserved
# NOTE: basic auth and oauth are mutually exclusive # NOTE: basic auth and oauth are mutually exclusive
#ZROK_OAUTH_PROVIDER="google" #ZROK_OAUTH_PROVIDER="google"

2
sdk/nodejs/sdk/src/environment/root.ts
View File

@ -76,7 +76,7 @@ export class Root {
} }
public ApiEndpoint(): ApiEndpoint { public ApiEndpoint(): ApiEndpoint {
let apiEndpoint = "https://api.zrok.io" let apiEndpoint = "https://api-v1.zrok.io"
let frm = "binary" let frm = "binary"
if (this.cfg.ApiEndpoint != "") { if (this.cfg.ApiEndpoint != "") {

2
sdk/python/examples/pastebin/README.md
View File

@ -4,7 +4,7 @@ This example shows the use of the zrok SDK spinning up a simple pastebin command
## Self-hosting Setup :wrench: ## Self-hosting Setup :wrench:
You don't need this section if you're using hosted zrok from NetFoundry (https://api.zrok.io/). You don't need this section if you're using hosted zrok from NetFoundry (https://api-v1.zrok.io/).
Refer to the [setup guide](../../../docs/guides/self-hosting/self_hosting_guide.md) for details on setting up your zrok Refer to the [setup guide](../../../docs/guides/self-hosting/self_hosting_guide.md) for details on setting up your zrok
environment if you're self-hosting zrok. environment if you're self-hosting zrok.

2
sdk/python/sdk/zrok/zrok/environment/root.py
View File

@ -61,7 +61,7 @@ class Root:
return zrock_client return zrock_client
def ApiEndpoint(self) -> ApiEndpoint: def ApiEndpoint(self) -> ApiEndpoint:
apiEndpoint = "https://api.zrok.io" apiEndpoint = "https://api-v1.zrok.io"
frm = "binary" frm = "binary"
if self.cfg.ApiEndpoint != "": if self.cfg.ApiEndpoint != "":