This is an automated email from the ASF dual-hosted git repository.
zhongxjian pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dubbo-kubernetes.git
The following commit(s) were added to refs/heads/master by this push:
new 5725e226 Update samples README (#866)
5725e226 is described below
commit 5725e226b554e0681e4b64a0d0d8bbfa216094d2
Author: Joe Zhong <[email protected]>
AuthorDate: Wed Feb 25 17:30:22 2026 +0800
Update samples README (#866)
---
samples/grpc-app/README.md | 211 +--------------------------------------------
samples/httpbin/README.md | 57 +-----------
2 files changed, 2 insertions(+), 266 deletions(-)
diff --git a/samples/grpc-app/README.md b/samples/grpc-app/README.md
index 967104ad..f5127ee7 100644
--- a/samples/grpc-app/README.md
+++ b/samples/grpc-app/README.md
@@ -1,212 +1,3 @@
# gRPC Proxyless Example
-This example demonstrates how to deploy gRPC applications with proxyless
service mesh support using Dubbo Kubernetes.
-
-## Overview
-
-This sample includes:
-- **Provider**: A gRPC server that receives requests (port 17070) and is
deployed with multiple versions (v1/v2) to showcase gray release scenarios.
-- **Consumer**: A gRPC client that sends requests to the provider service and
exposes a test server (port 17171) for driving traffic via `grpcurl`.
-
-Both services use native gRPC xDS clients to connect to the Dubbo control
plane through the `dubbo-proxy` sidecar, enabling service discovery, load
balancing, and traffic management without requiring Envoy proxy for application
traffic.
-
-## Prerequisites
-
-1. Kubernetes cluster with Dubbo Kubernetes control plane installed
-2. `kubectl` configured to access the cluster
-3. `grpcurl` (optional, for testing)
-
-## Deployment
-
-### 1. Create Namespace
-
-```bash
-kubectl create ns grpc-app
-kubectl label namespace grpc-app dubbo-injection=enabled
-```
-
-### 2. Deploy Services
-
-```bash
-kubectl apply -f grpc-app.yaml
-```
-
-### 3. Test service
-
-```bash
-kubectl port-forward -n grpc-app $(kubectl get pod -l app=consumer -n grpc-app
-o jsonpath='{.items[0].metadata.name}') 17171:17171
-```
-
-```bash
-grpcurl -plaintext -d '{"url":
"xds:///provider.grpc-app.svc.cluster.local:7070","count": 5}' localhost:17171
echo.EchoTestService/ForwardEcho
-```
-
-```json
-{
- "output": [
- "[0 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[1 body] Hostname=provider-v1-fbb7b9bd9-l8frj ServiceVersion=v1
Namespace=grpc-app IP=192.168.219.119 ServicePort=17070",
- "[2 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[3 body] Hostname=provider-v1-fbb7b9bd9-l8frj ServiceVersion=v1
Namespace=grpc-app IP=192.168.219.119 ServicePort=17070",
- "[4 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070"
- ]
-}
-```
-
-## Traffic Management
-
-### Creating subsets with DestinationRule
-
-First, create a subset for each version of the workload to enable traffic
splitting:
-
-```bash
-cat <<EOF | kubectl apply -f -
-apiVersion: networking.dubbo.apache.org/v1alpha3
-kind: DestinationRule
-metadata:
- name: provider-versions
- namespace: grpc-app
-spec:
- host: provider.grpc-app.svc.cluster.local
- subsets:
- - name: v1
- labels:
- version: v1
- - name: v2
- labels:
- version: v2
-EOF
-```
-
-### Traffic shifting
-
-Using the subsets defined above, you can send weighted traffic to different
versions. The following example sends 10% of traffic to v1 and 90% to v2:
-
-```bash
-cat <<EOF | kubectl apply -f -
-apiVersion: networking.dubbo.apache.org/v1alpha3
-kind: VirtualService
-metadata:
- name: provider-weights
- namespace: grpc-app
-spec:
- hosts:
- - provider.grpc-app.svc.cluster.local
- http:
- - route:
- - destination:
- host: provider.grpc-app.svc.cluster.local
- subset: v1
- weight: 10
- - destination:
- host: provider.grpc-app.svc.cluster.local
- subset: v2
- weight: 90
-EOF
-```
-
-Now, send a set of 5 requests to verify the traffic distribution:
-
-```bash
-grpcurl -plaintext -d '{"url":
"xds:///provider.grpc-app.svc.cluster.local:7070","count": 5}' localhost:17171
echo.EchoTestService/ForwardEcho
-```
-
-The response should contain mostly `v2` responses, demonstrating the weighted
traffic splitting:
-
-```json
-{
- "output": [
- "[0 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[1 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[2 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[3 body] Hostname=provider-v1-fbb7b9bd9-l8frj ServiceVersion=v1
Namespace=grpc-app IP=192.168.219.119 ServicePort=17070",
- "[4 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070"
- ]
-}
-```
-
-## Enabling mTLS
-
-Due to the changes to the application itself required to enable security in
gRPC, Dubbo Kubernetes's traditional method of automatically detecting mTLS
support is unreliable. For this reason, the initial release requires explicitly
enabling mTLS on both the client and server.
-
-### Enable client-side mTLS
-
-To enable client-side mTLS, apply a `DestinationRule` with `tls` settings:
-
-```bash
-cat <<EOF | kubectl apply -f -
-apiVersion: networking.dubbo.apache.org/v1alpha3
-kind: DestinationRule
-metadata:
- name: provider-mtls
- namespace: grpc-app
-spec:
- host: provider.grpc-app.svc.cluster.local
- trafficPolicy:
- tls:
- mode: DUBBO_MUTUAL
-EOF
-```
-
-Now an attempt to call the server that is not yet configured for mTLS will
fail:
-
-```bash
-grpcurl -plaintext -d '{"url":
"xds:///provider.grpc-app.svc.cluster.local:7070","count": 5}' localhost:17171
echo.EchoTestService/ForwardEcho
-```
-
-Expected error output:
-```json
-{
- "output": [
- "ERROR:\nCode: Unknown\nMessage: 5/5 requests had errors; first error:
rpc error: code = Unavailable desc = connection error: desc = \"transport:
authentication handshake failed: tls: first record does not look like a TLS
handshake\"",
- "[0] Error: rpc error: code = Unavailable desc = connection error: desc
= \"transport: authentication handshake failed: tls: first record does not look
like a TLS handshake\"",
- "[1] Error: rpc error: code = Unavailable desc = connection error: desc
= \"transport: authentication handshake failed: tls: first record does not look
like a TLS handshake\"",
- "[2] Error: rpc error: code = Unavailable desc = connection error: desc
= \"transport: authentication handshake failed: tls: first record does not look
like a TLS handshake\"",
- "[3] Error: rpc error: code = Unavailable desc = connection error: desc
= \"transport: authentication handshake failed: tls: first record does not look
like a TLS handshake\"",
- "[4] Error: rpc error: code = Unavailable desc = connection error: desc
= \"transport: authentication handshake failed: tls: first record does not look
like a TLS handshake\""
- ]
-}
-```
-
-### Enable server-side mTLS
-
-To enable server-side mTLS, apply a `PeerAuthentication` policy. The following
policy forces STRICT mTLS for the entire namespace:
-
-```bash
-cat <<EOF | kubectl apply -f -
-apiVersion: security.dubbo.apache.org/v1alpha3
-kind: PeerAuthentication
-metadata:
- name: provider-mtls
- namespace: grpc-app
-spec:
- mtls:
- mode: STRICT
-EOF
-```
-
-Requests will start to succeed after applying the policy:
-
-```bash
-grpcurl -plaintext -d '{"url":
"xds:///provider.grpc-app.svc.cluster.local:7070","count": 5}' localhost:17171
echo.EchoTestService/ForwardEcho
-```
-
-Expected successful output:
-```json
-{
- "output": [
- "[0 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[1 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[2 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[3 body] Hostname=provider-v2-594b6977c8-5gw2z ServiceVersion=v2
Namespace=grpc-app IP=192.168.219.88 ServicePort=17070",
- "[4 body] Hostname=provider-v1-fbb7b9bd9-l8frj ServiceVersion=v1
Namespace=grpc-app IP=192.168.219.119 ServicePort=17070"
- ]
-}
-```
-
-## Cleanup
-
-```bash
-kubectl delete -f grpc-app.yaml
-kubectl delete ns grpc-app
-```
+This is an example demonstrating a gRPC application.
\ No newline at end of file
diff --git a/samples/httpbin/README.md b/samples/httpbin/README.md
index e49ea78e..7f9ebf0c 100644
--- a/samples/httpbin/README.md
+++ b/samples/httpbin/README.md
@@ -1,58 +1,3 @@
# Httpbin Service
-```bash
-kubectl get crd gateways.gateway.networking.k8s.io &> /dev/null || \
-{ kubectl kustomize
"github.com/kubernetes-sigs/gateway-api/config/crd?ref=v1.4.0" | kubectl apply
-f -; }
-```
-
-```yaml
-kubectl create namespace dubbo-ingress
-kubectl apply -f - <<EOF
-apiVersion: gateway.networking.k8s.io/v1
-kind: Gateway
-metadata:
- name: gateway
- namespace: dubbo-ingress
-spec:
- gatewayClassName: dubbo
- listeners:
- - name: default
- hostname: "*.example.com"
- port: 80
- protocol: HTTP
- allowedRoutes:
- namespaces:
- from: All
----
-apiVersion: gateway.networking.k8s.io/v1
-kind: HTTPRoute
-metadata:
- name: http
- namespace: default
-spec:
- parentRefs:
- - name: gateway
- namespace: dubbo-ingress
- hostnames: ["httpbin.example.com"]
- rules:
- - matches:
- - path:
- type: PathPrefix
- value: /get
- backendRefs:
- - name: httpbin
- port: 8000
-EOF
-```
-
-```bash
-NODE_IP=$(kubectl get nodes -o
jsonpath='{.items[0].status.addresses[?(@.type=="InternalIP")].address}')
-SVC_PORT=$(kubectl get svc gateway-dubbo -n dubbo-ingress -o
jsonpath='{.spec.ports[?(@.port==80)].nodePort}')
-curl -s -I -HHost:httpbin.example.com "http://$NODE_IP:$SVC_PORT/get";
-```
-
-```bash
-kubectl delete httproute http
-kubectl delete gateways.gateway.networking.k8s.io gateway -n dubbo-ingress
-kubectl delete ns dubbo-ingress
-```
\ No newline at end of file
+This is an example demonstrating the httpbin service.
\ No newline at end of file
