From 5707c37b63e6bc2a86ca26e034a3fb6e988221ad Mon Sep 17 00:00:00 2001 From: Pasha Sviderski Date: Fri, 12 Dec 2025 18:21:11 +1000 Subject: [PATCH] docs: replace managed DNS domain: cluster.uncloud.run -> uncld.dev --- AI.md | 2 +- README.md | 2 +- cmd/uncloud/dns/root.go | 2 +- cmd/uncloud/machine/init.go | 2 +- misc/user_guide.md | 2 +- website/docs/1-overview.md | 2 +- .../docs/2-getting-started/2-deploy-demo-app.md | 16 ++++++++-------- website/docs/9-cli-reference/uc_dns.md | 2 +- website/docs/9-cli-reference/uc_machine_init.md | 2 +- 9 files changed, 16 insertions(+), 16 deletions(-) diff --git a/AI.md b/AI.md index 49edf1fd..b496fce3 100644 --- a/AI.md +++ b/AI.md @@ -28,7 +28,7 @@ This document provides comprehensive information about the Uncloud project for A - **Docker Compose compatibility**: Uses familiar Docker Compose format - **Zero-downtime deployments**: Rolling updates without service interruption - **Automatic HTTPS**: Caddy reverse proxy with Let's Encrypt integration -- **Managed DNS**: Free `*.cluster.uncloud.run` subdomains via Uncloud DNS service +- **Managed DNS**: Free `*.xxxxxx.uncld.dev` subdomains via Uncloud DNS service - **Cross-machine scaling**: Run containers across multiple machines ### 🔧 Developer Experience diff --git a/README.md b/README.md index 4c41e2b9..b76fb949 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ complexity of Kubernetes. * **No control plane**: Fully decentralised design eliminates single points of failure and reduces operational overhead. * **Imperative over declarative**: Favoring imperative operations over state reconciliation simplifies both the mental model and troubleshooting. -* **Managed DNS**: Automatic DNS records `*..cluster.uncloud.run` for services with public access via managed +* **Managed DNS**: Automatic DNS records `*.xxxxxx.uncld.dev` for services with public access via managed [Uncloud DNS](https://github.com/psviderski/uncloud-dns) service. * **Automatic HTTPS**: Built-in Caddy reverse proxy handles TLS certificate provisioning and renewal using Let's Encrypt. diff --git a/cmd/uncloud/dns/root.go b/cmd/uncloud/dns/root.go index 2f906414..187afafb 100644 --- a/cmd/uncloud/dns/root.go +++ b/cmd/uncloud/dns/root.go @@ -9,7 +9,7 @@ func NewRootCommand() *cobra.Command { Use: "dns", Short: "Manage cluster domain in Uncloud DNS.", Long: "Manage cluster domain in Uncloud DNS.\n" + - "DNS commands allow you to reserve or release a unique '.cluster.uncloud.run' domain for your " + + "DNS commands allow you to reserve or release a unique 'xxxxxx.uncld.dev' domain for your " + "cluster. When reserved, Caddy service deployments will automatically update DNS records to route " + "traffic to the services in the cluster.", } diff --git a/cmd/uncloud/machine/init.go b/cmd/uncloud/machine/init.go index 511dac9d..1de3c6c3 100644 --- a/cmd/uncloud/machine/init.go +++ b/cmd/uncloud/machine/init.go @@ -50,7 +50,7 @@ Connection methods: # Initialise with a non-root user and custom SSH port and key. uc machine init ubuntu@:2222 -i ~/.ssh/mykey - # Initialise without Caddy (no reverse proxy) and without an automatically managed domain name (xxxxxx.cluster.uncloud.run). + # Initialise without Caddy (no reverse proxy) and without an automatically managed domain name (xxxxxx.uncld.dev). # You can deploy Caddy with 'uc caddy deploy' and reserve a domain with 'uc dns reserve' later. uc machine init root@ --no-caddy --no-dns`, // TODO: support initialising a cluster on the local machine. diff --git a/misc/user_guide.md b/misc/user_guide.md index 249e62a4..11b200c4 100644 --- a/misc/user_guide.md +++ b/misc/user_guide.md @@ -22,7 +22,7 @@ Uncloud stores its configuration in `~/.config/uncloud/config.yaml`. If you wish Begin by initialising the first node in your cluster with `uc machine init [USER@HOST:PORT]`. If you do not have a need for Caddy reverse proxy, you may disable this feature with `--no-caddy`. If you want to avoid using uncloud's managed DNS service, add the `--no-dns` flag. -This command will idempotently install Docker, uncloudd, uncloud-corrosion. If Caddy is enabled, it will set up a reverse proxy. If Uncloud DNS is enabled, it will create a DNS A record for the machine's public IP address under `*.[CLUSTER ID].cluster.uncloud.run`. +This command will idempotently install Docker, uncloudd, uncloud-corrosion. If Caddy is enabled, it will set up a reverse proxy. If Uncloud DNS is enabled, it will create a DNS A record for the machine's public IP address under `*.[CLUSTER ID].uncld.dev`. If you wish to uninstall Uncloud and its components, run `uncloud-uninstall`. diff --git a/website/docs/1-overview.md b/website/docs/1-overview.md index be5025ec..7c67f9ad 100644 --- a/website/docs/1-overview.md +++ b/website/docs/1-overview.md @@ -69,7 +69,7 @@ Talos [KubeSpan](https://www.talos.dev/v1.10/talos-guides/network/kubespan/). ### Managed DNS service (optional) -Uncloud can provide **managed DNS records** like `..cluster.uncloud.run` for your public +Uncloud can provide **managed DNS records** like `..uncld.dev` for your public services through free [Uncloud DNS](https://github.com/psviderski/uncloud-dns) service. You can deploy a service and instantly access it from anywhere with a proper DNS name and HTTPS without any manual DNS configuration. This makes self-hosting much more accessible and simplifies the process of adding your own domain later. diff --git a/website/docs/2-getting-started/2-deploy-demo-app.md b/website/docs/2-getting-started/2-deploy-demo-app.md index 723fc0e1..6ecfd5f9 100644 --- a/website/docs/2-getting-started/2-deploy-demo-app.md +++ b/website/docs/2-getting-started/2-deploy-demo-app.md @@ -45,7 +45,7 @@ This command will: - Install the Uncloud daemon on your server - Create a Docker network for Uncloud-managed containers - Deploy [Caddy](https://caddyserver.com/) as your reverse proxy listening on host ports 80 and 443 -- Reserve a free `xxxxxx.cluster.uncloud.run` subdomain via the Uncloud managed DNS service and point it to your +- Reserve a free `xxxxxx.uncld.dev` subdomain via the Uncloud managed DNS service and point it to your server's IP All in about a minute! @@ -144,7 +144,7 @@ Cluster initialised with machine 'machine-dc3c' and saved as context 'default' i Current cluster context is now 'default'. Waiting for the machine to be ready... -Reserved cluster domain: 7za6s7.cluster.uncloud.run +Reserved cluster domain: 7za6s7.uncld.dev [+] Deploying service caddy 7/2 ✔ Container caddy-d7uk on machine-dc3c Started 6.1s ✔ Image caddy:2.10.0 on machine-dc3c Pulled 3.7s @@ -154,7 +154,7 @@ Updating cluster domain records in Uncloud DNS to point to machines running cadd ✔ Machine machine-dc3c (157.180.72.195) Reachable 0.7s DNS records updated to use only the internet-reachable machines running caddy service: - *.7za6s7.cluster.uncloud.run A → 157.180.72.195 + *.7za6s7.uncld.dev A → 157.180.72.195 ``` @@ -177,7 +177,7 @@ You'll see the progress of the deployment and the public URL where you can acces ✔ Image excalidraw/excalidraw on machine-dc3c Pulled 4.7s excalidraw endpoints: - • https://excalidraw.7za6s7.cluster.uncloud.run → :80 + • https://excalidraw.7za6s7.uncld.dev → :80 ``` ## Verify your deployment @@ -209,7 +209,7 @@ uc ls ``` NAME MODE REPLICAS ENDPOINTS caddy global 1 -excalidraw replicated 1 https://excalidraw.7za6s7.cluster.uncloud.run → :80 +excalidraw replicated 1 https://excalidraw.7za6s7.uncld.dev → :80 ``` You can see `caddy` service listed here. That's your reverse proxy, running as a regular Uncloud service. @@ -266,15 +266,15 @@ We've successfully converted our deployment created with `uc run` to a Compose f ## Use your own domain -Want to use your own domain, for example, `excalidraw.example.com` instead of `excalidraw.7za6s7.cluster.uncloud.run`? +Want to use your own domain, for example, `excalidraw.example.com` instead of `excalidraw.7za6s7.uncld.dev`? Add a CNAME record `excalidraw.example.com` in your DNS provider (Cloudflare, Namecheap, etc.) pointing to -`excalidraw.7za6s7.cluster.uncloud.run`. Alternatively, you can add an A record pointing to your server's IP. +`excalidraw.7za6s7.uncld.dev`. Alternatively, you can add an A record pointing to your server's IP. :::info note These instructions set up your own domain **in addition to** the Uncloud managed DNS name -`excalidraw.7za6s7.cluster.uncloud.run`. +`excalidraw.7za6s7.uncld.dev`. If you want to avoid the managed service altogether, add `--no-dns` to your `uc machine init` command, and point an A DNS record to your server(s)'s IP(s). diff --git a/website/docs/9-cli-reference/uc_dns.md b/website/docs/9-cli-reference/uc_dns.md index bad6335a..bdc3cede 100644 --- a/website/docs/9-cli-reference/uc_dns.md +++ b/website/docs/9-cli-reference/uc_dns.md @@ -5,7 +5,7 @@ Manage cluster domain in Uncloud DNS. ## Synopsis Manage cluster domain in Uncloud DNS. -DNS commands allow you to reserve or release a unique '\.cluster.uncloud.run' domain for your cluster. When reserved, Caddy service deployments will automatically update DNS records to route traffic to the services in the cluster. +DNS commands allow you to reserve or release a unique 'xxxxxx.uncld.dev' domain for your cluster. When reserved, Caddy service deployments will automatically update DNS records to route traffic to the services in the cluster. ## Options diff --git a/website/docs/9-cli-reference/uc_machine_init.md b/website/docs/9-cli-reference/uc_machine_init.md index a6be0751..de2dac01 100644 --- a/website/docs/9-cli-reference/uc_machine_init.md +++ b/website/docs/9-cli-reference/uc_machine_init.md @@ -27,7 +27,7 @@ uc machine init [USER@HOST:PORT] [flags] # Initialise with a non-root user and custom SSH port and key. uc machine init ubuntu@:2222 -i ~/.ssh/mykey - # Initialise without Caddy (no reverse proxy) and without an automatically managed domain name (xxxxxx.cluster.uncloud.run). + # Initialise without Caddy (no reverse proxy) and without an automatically managed domain name (xxxxxx.uncld.dev). # You can deploy Caddy with 'uc caddy deploy' and reserve a domain with 'uc dns reserve' later. uc machine init root@ --no-caddy --no-dns ```