Skip to content

docs: Initial notes for "services" docs #136

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.

Sign up for GitHub

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

Merged
psviderski merged 1 commit into from
Oct 8, 2025
Merged

docs: Initial notes for "services" docs #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions website/docs/3-concepts/6-services/1-internal-dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Internal DNS

Services can be addressed on the internal WireGuard network by service name, service ID, or a machine-scoped service name:

## Service name
```
$ nslookup nats.internal
Server: 127.0.0.11
Address: 127.0.0.11#53

Name: nats.internal
Address: 10.210.0.2
Name: nats.internal
Address: 10.210.1.2
```

```
$ nslookup worker.internal
Server: 127.0.0.11
Address: 127.0.0.11#53

Name: worker.internal
Address: 10.210.0.3
Name: worker.internal
Address: 10.210.0.4
Name: worker.internal
Address: 10.210.1.3
Name: worker.internal
Address: 10.210.1.4
```

## Service ID
```
$ nslookup 3ecb3a8bbec5fd3f46efb056a934714a.internal
Server: 127.0.0.11
Address: 127.0.0.11#53

Name: 3ecb3a8bbec5fd3f46efb056a934714a.internal
Address: 10.210.0.4
```

## Machine ID scoped service name
```
$ nslookup 0903f0ee483aa97d559eeeaac5e22283.m.nats.internal
Server: 127.0.0.11
Address: 127.0.0.11#53

Name: nats.internal
Address: 10.210.1.2
```

```
$ nslookup 0903f0ee483aa97d559eeeaac5e22283.m.worker.internal
Server: 127.0.0.11
Address: 127.0.0.11#53

Name: worker.internal
Address: 10.210.1.3
Name: worker.internal
Address: 10.210.1.4
```
8 changes: 8 additions & 0 deletions website/docs/3-concepts/6-services/2-container-env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Container ENV Variables

- `UNCLOUD_MACHINE_ID`
- Machine ID the service container is running on.
- Example: `UNCLOUD_MACHINE_ID=0903f0ee483aa97d559eeeaac5e22283`
- `HOSTNAME`
- Service name with unique suffix.
- Example: `HOSTNAME=worker-c1zd`
4 changes: 4 additions & 0 deletions website/docs/3-concepts/6-services/_category_.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
label: Services
collapsed: true # keep the category closed by default
link:
type: generated-index