Skip to content

Commit 13e1c8e

Browse files
Merge branch 'main' into docs/port-operator-guide-updates
2 parents 0edaad8 + b248316 commit 13e1c8e

15 files changed

Lines changed: 141 additions & 454 deletions

File tree

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ APPS ?= tenant clickhouse foundationdb harbor redis mongodb openbao rabbit
7676
K8S ?= kubernetes
7777
K8S_NODES ?= kubernetes-nodes
7878
VMS ?= vm-disk vm-instance
79-
NETWORKING ?= vpc vpn http-cache tcp-balancer
79+
NETWORKING ?= vpc vpn tcp-balancer
8080
SERVICES ?= bootbox etcd ingress monitoring seaweedfs
8181
SERVICES += computeplane gateway
8282
APPS_DEST_DIR ?= content/en/docs/$(DOC_VERSION)/applications

‎content/en/docs/next/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ weight: 5
1414
{{% /warning %}}
1515
Cozystack is a free PaaS platform and framework for building clouds
1616

17-
With Cozystack, you can transform your bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.
17+
With Cozystack, you can transform your bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, and other services with ease.
1818

1919
You can use Cozystack to build your own cloud or to provide a cost-effective development environments.

‎content/en/docs/next/cozystack-api/_index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ clickhouses apps.cozystack.io/v1alpha1 true ClickHouse
2727
etcds apps.cozystack.io/v1alpha1 true Etcd
2828
foundationdbs apps.cozystack.io/v1alpha1 true FoundationDB
2929
harbors apps.cozystack.io/v1alpha1 true Harbor
30-
httpcaches apps.cozystack.io/v1alpha1 true HTTPCache
3130
infos apps.cozystack.io/v1alpha1 true Info
3231
ingresses apps.cozystack.io/v1alpha1 true Ingress
3332
kafkas apps.cozystack.io/v1alpha1 true Kafka

‎content/en/docs/next/cozystack-api/application-definitions.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -40,45 +40,45 @@ the chart referenced by the definition.
4040
sets them explicitly, and the relationship between them is **not derivable
4141
by any string transform**:
4242

43-
| Field | Style | Example (HTTP cache) | Example (VM disk) | Example (TCP balancer) |
43+
| Field | Style | Example (VM instance) | Example (VM disk) | Example (TCP balancer) |
4444
| --- | --- | --- | --- | --- |
45-
| `metadata.name` | lowercase-with-hyphens | `http-cache` | `vm-disk` | `tcp-balancer` |
46-
| `spec.application.kind` | CamelCase, preserves acronyms | `HTTPCache` | `VMDisk` | `TCPBalancer` |
47-
| `spec.application.singular` | lowercase, no hyphens | `httpcache` | `vmdisk` | `tcpbalancer` |
48-
| `spec.application.plural` | lowercase, no hyphens | `httpcaches` | `vmdisks` | `tcpbalancers` |
45+
| `metadata.name` | lowercase-with-hyphens | `vm-instance` | `vm-disk` | `tcp-balancer` |
46+
| `spec.application.kind` | CamelCase, preserves acronyms | `VMInstance` | `VMDisk` | `TCPBalancer` |
47+
| `spec.application.singular` | lowercase, no hyphens | `vminstance` | `vmdisk` | `tcpbalancer` |
48+
| `spec.application.plural` | lowercase, no hyphens | `vminstances` | `vmdisks` | `tcpbalancers` |
4949

5050
Note that `metadata.name` is not a function of `spec.application.kind`. The
51-
hyphen positions (`tcp-balancer`, `vm-disk`, `http-cache`) and the absence of
52-
hyphens in `singular`/`plural` (`tcpbalancer`, `vmdisk`, `httpcache`) are
51+
hyphen positions (`tcp-balancer`, `vm-disk`, `vm-instance`) and the absence of
52+
hyphens in `singular`/`plural` (`tcpbalancer`, `vmdisk`, `vminstance`) are
5353
conventions chosen per application, not outputs of a shared algorithm.
54-
`strings.ToLower(kind)` yields `httpcache`, which matches
54+
`strings.ToLower(kind)` yields `vminstance`, which matches
5555
`spec.application.singular` but **not** `metadata.name`. A direct lookup by
5656
the lowercased kind therefore fails:
5757

5858
```bash
5959
# The aggregated API resource uses the lowercased plural:
60-
$ kubectl get httpcaches --namespace tenant-demo
60+
$ kubectl get vminstances --namespace tenant-demo
6161
NAME READY AGE VERSION
6262
frontend True 2m 1.2.0
6363

6464
# But the ApplicationDefinition that backs it is stored under a different name:
65-
$ kubectl get applicationdefinition httpcache
66-
Error from server (NotFound): applicationdefinitions.cozystack.io "httpcache" not found
65+
$ kubectl get applicationdefinition vminstance
66+
Error from server (NotFound): applicationdefinitions.cozystack.io "vminstance" not found
6767

68-
$ kubectl get applicationdefinition http-cache
69-
NAME AGE
70-
http-cache 14d
68+
$ kubectl get applicationdefinition vm-instance
69+
NAME AGE
70+
vm-instance 14d
7171
```
7272

73-
Acronyms make this more visible: `TCPBalancer`, `HTTPCache`, and `VMDisk` all
73+
Acronyms make this more visible: `TCPBalancer`, `VMInstance`, and `VMDisk` all
7474
lose their capitalisation in the aggregated resource name (`tcpbalancers`,
75-
`httpcaches`, `vmdisks`) but keep hyphens in the CRD name (`tcp-balancer`,
76-
`http-cache`, `vm-disk`).
75+
`vminstances`, `vmdisks`) but keep hyphens in the CRD name (`tcp-balancer`,
76+
`vm-instance`, `vm-disk`).
7777

7878
## Recommended lookup pattern
7979

8080
Client code that needs to resolve a Cozystack kind — for example a dashboard
81-
that receives `HTTPCache` from a HelmRelease label and wants to render the
81+
that receives `VMInstance` from a HelmRelease label and wants to render the
8282
matching form — should **list all `ApplicationDefinition`s and filter by
8383
`spec.application.kind`** instead of attempting a direct `Get` by the lowercased
8484
kind. The set of definitions is small (tens of items) and changes rarely, so
@@ -175,7 +175,7 @@ aggressively a client should cache therefore depends on its own lifetime:
175175
driven rolling restart of `cozystack-api` completes.
176176

177177
{{% alert color="info" %}}
178-
The lowercased plural (`httpcaches`, `vmdisks`) **is** the correct name for
178+
The lowercased plural (`vminstances`, `vmdisks`) **is** the correct name for
179179
tenant-facing resources under `apps.cozystack.io/v1alpha1`. It is only the
180180
`applicationdefinitions.cozystack.io` CRD that uses the hyphenated form.
181181
{{% /alert %}}

‎content/en/docs/next/guides/concepts.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Read more: [tenant Kubernetes clusters]({{% ref "/docs/next/kubernetes" %}}).
5353
## Managed Applications
5454

5555
Cozystack comes with a catalog of **managed applications** (services) that can be deployed on the platform with minimal effort.
56-
These include relational databases (PostgreSQL, MySQL/MariaDB), NoSQL/queues (Redis, NATS, Kafka, RabbitMQ), HTTP cache, load balancer, and others.
56+
These include relational databases (PostgreSQL, MySQL/MariaDB), NoSQL/queues (Redis, NATS, Kafka, RabbitMQ), load balancer, and others.
5757

5858
Tenants, tenant Kubernetes clusters, and VMs are also managed applications in terms of Cozystack.
5959
They are created with the same user workflow and are managed with Helm and Flux, just as other applications.

‎content/en/docs/next/guides/platform-stack/_index.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,6 @@ Cozystack-maintained charts, CRDs, controllers, and application APIs are license
129129
## Managed networking services
130130

131131
{{< oss-cards >}}
132-
{{< oss-card name="NGINX" logo="nginx" license="BSD-2-Clause" source="https://github.com/nginx/nginx/blob/master/LICENSE" description="Powers the managed HTTP Cache service with reverse-proxy caching and GeoIP filtering. Scales horizontally without a shared filesystem." >}}
133-
{{< oss-card name="HAProxy" logo="haproxy" license="GPL-2.0 with exceptions" source="https://github.com/haproxy/haproxy/blob/master/LICENSE" description="Enterprise TCP/HTTP load balancer powering the managed TCP Balancer and HTTP Cache. Provides active health checks and high-throughput connection handling." >}}
134-
{{< oss-card name="IP2Location modules" license="MIT" source="https://github.com/ip2location/ip2location-nginx/blob/master/LICENSE" description="GeoIP modules (IP2Location and IP2Proxy) bundled into the HTTP Cache. Enables country-based traffic filtering and proxy/VPN detection." >}}
132+
{{< oss-card name="HAProxy" logo="haproxy" license="GPL-2.0 with exceptions" source="https://github.com/haproxy/haproxy/blob/master/LICENSE" description="Enterprise TCP/HTTP load balancer powering the managed TCP Balancer. Provides active health checks and high-throughput connection handling." >}}
135133
{{< oss-card name="Outline Server (Shadowsocks)" logo="outline" license="Apache-2.0" source="https://github.com/OutlineFoundation/outline-server/blob/master/LICENSE" description="Shadowsocks-based VPN backend developed by Google's Jigsaw team. Manages Shadowsocks instances with symmetric encryption to resist DPI traffic analysis." >}}
136134
{{< /oss-cards >}}

‎content/en/docs/next/networking/_include/http-cache.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)