MengMengCode
a45e063fc2
- Introduced Container Management documentation covering lifecycle operations, resource management, and console access. - Added Dashboard documentation detailing metrics and related APIs. - Created Host Report documentation summarizing host environment and resource status. - Included Image Management documentation for template handling and management actions. - Documented Networking and Routing features including NAT4 and IPv6 management. - Added Security Alerts documentation outlining alert scenarios and API usage. - Created Snapshot Management documentation for snapshot operations and scheduling. - Documented Sub-user management for granting access to specific containers. - Added Configuration guide detailing runtime settings and security recommendations. - Created Installation guide for setting up CLICD with requirements and steps. - Added Introduction and Quick Start guides for new users. - Documented Upgrade process with version checking and pre-upgrade checklist. - Created Deployment guide for service exposure and firewall recommendations. - Added FAQ section addressing common questions and concerns. - Documented Troubleshooting steps for common issues encountered.
1.9 KiB
Networking and Routing
CLICD provides NAT4 port mapping, random available ports, public IPv4 assignment, IPv6 status checks, and IPv6 assignment. During container creation, you can use NAT only, public IPv4 only, IPv6 only, or a mixed network setup.
NAT4
NAT4 forwards host ports to container internal ports. Common uses include:
- Forwarding SSH.
- Exposing web services.
- Assigning fixed external ports to sub-users.
Port mappings include:
| Field | Description |
|---|---|
| Name | A purpose label such as ssh or web. |
| Protocol | tcp or udp. |
| External port | The host port exposed to the outside. |
| Internal port | The service port inside the container. |
IPv6
IPv6 assignment requires the host to have a routable IPv6 prefix, plus correct routing, neighbor discovery, or proxy configuration.
GET /api/v1/ipv6/status
POST /api/v1/containers/{id}/ipv6
If the host has no public IPv6 or the upstream network is not routing the prefix correctly, assigned addresses will not be reachable from the public internet.
Public IPv4
Public IPv4 assignment selects from public IPv4 addresses detected on the host, or from public_ipv4s specified through the API. Creation fields include:
| Field | Description |
|---|---|
assign_nat |
Whether to enable NAT port mappings. |
assign_ipv4 |
Whether to assign public IPv4. |
ipv4_count |
Number of public IPv4 addresses to allocate automatically. |
public_ipv4s |
Explicit public IPv4 address list. |
assign_ipv6 |
Whether to assign IPv6. |
ipv6_count |
Number of IPv6 addresses to allocate automatically. |
ipv6_addresses |
Explicit IPv6 address list. |
Public address pool APIs:
GET /api/v1/routing
PUT /api/v1/routing
POST /api/v1/routing/ipv4-scan
Routing Status
GET /api/v1/routing
This endpoint shows runtime status for NAT, IPv4, IPv6, and port capacity.