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 ebdfb5b3 [chore] Delete redundant directories (#660)
ebdfb5b3 is described below
commit ebdfb5b370776bd7c676e5705d5730c6e5ad2b2f
Author: Jian Zhong <[email protected]>
AuthorDate: Thu Mar 27 09:28:29 2025 +0800
[chore] Delete redundant directories (#660)
---
docs/dubboctl/concepts.md | 186 ---------------------
.../dubboctl/dashboard/dubboctl_dashboard_admin.md | 30 ----
.../dashboard/dubboctl_dashboard_grafana.md | 28 ----
.../dubboctl/dashboard/dubboctl_dashboard_nacos.md | 28 ----
.../dashboard/dubboctl_dashboard_prometheus.md | 28 ----
.../dashboard/dubboctl_dashboard_skywalking.md | 28 ----
.../dashboard/dubboctl_dashboard_zipkin.md | 28 ----
docs/dubboctl/deploy.md | 43 -----
docs/dubboctl/dubboctl.md | 41 -----
docs/dubboctl/dubboctl_build.md | 22 ---
docs/dubboctl/dubboctl_create.md | 81 ---------
docs/dubboctl/dubboctl_dashboard.md | 29 ----
docs/dubboctl/dubboctl_deploy.md | 42 -----
docs/dubboctl/dubboctl_env.md | 48 ------
docs/dubboctl/dubboctl_help.md | 21 ---
docs/dubboctl/dubboctl_structure.md | 121 --------------
docs/dubboctl/manifest/dubboctl_manifest.md | 23 ---
docs/dubboctl/manifest/dubboctl_manifest_diff.md | 24 ---
.../manifest/dubboctl_manifest_generate.md | 26 ---
.../dubboctl/manifest/dubboctl_manifest_install.md | 25 ---
.../manifest/dubboctl_manifest_uninstall.md | 27 ---
docs/dubboctl/profile/dubboctl_profile.md | 17 --
docs/dubboctl/profile/dubboctl_profile_diff.md | 22 ---
docs/dubboctl/profile/dubboctl_profile_list.md | 22 ---
docs/dubboctl/quick_start.md | 36 ----
docs/dubboctl/repository/dubboctl_repository.md | 136 ---------------
.../dubboctl/repository/dubboctl_repository_add.md | 17 --
.../repository/dubboctl_repository_list.md | 20 ---
.../repository/dubboctl_repository_remove.md | 20 ---
.../repository/dubboctl_repository_rename.md | 20 ---
docs/generated/policies.md | 17 --
docs/static/README.md | 3 -
docs/static/images/homepage/arch1.png | Bin 41551 -> 0 bytes
docs/static/images/homepage/arch2.png | Bin 28092 -> 0 bytes
docs/static/images/homepage/kubernetes-mode.png | Bin 26970 -> 0 bytes
docs/static/images/homepage/multiple-cluster.png | Bin 55935 -> 0 bytes
docs/static/images/homepage/ui-demo.png | Bin 160579 -> 0 bytes
docs/static/images/homepage/universal-mode.png | Bin 45225 -> 0 bytes
docs/static/images/ide_configuration.png | Bin 102005 -> 0 bytes
docs/static/images/index.png | Bin 267103 -> 0 bytes
docs/static/images/logo.png | Bin 5564 -> 0 bytes
docs/static/images/profile-eclipse.jpg | Bin 140714 -> 0 bytes
docs/static/images/profile-idea.jpg | Bin 75941 -> 0 bytes
job.yaml | 45 -----
operator/pkg/helm/helm.go | 5 +-
operator/pkg/manifest/manifest.go | 4 +-
operator/pkg/{parts => util}/parts.go | 2 +-
traffic/authority.yaml | 28 ----
traffic/config.yaml | 49 ------
traffic/rbac.yaml | 30 ----
50 files changed, 5 insertions(+), 1417 deletions(-)
diff --git a/docs/dubboctl/concepts.md b/docs/dubboctl/concepts.md
deleted file mode 100644
index 32308c38..00000000
--- a/docs/dubboctl/concepts.md
+++ /dev/null
@@ -1,186 +0,0 @@
-# Concepts
-
-## dubboctl Manifest and Profile
-
-### Manifest
-
-Dubbo-kubernetes, as a central control component, needs to launch various
components such as Grafana, Prometheus,
-Skywalking, Zipkin, Nacos, Zookeeper, etc., to provide additional
functionality. In a Kubernetes environment, the
-configuration YAML that describes these components is referred to as the
"manifest." It's also the final result
-processed by dubboctl, which can be used with tools like kubectl to directly
launch the required components.
-
-Dubboctl utilizes the Helm API to render the Helm Charts for various
components to generate the manifest. Among these,
-the Helm Charts for Admin and Nacos are maintained by the Dubbo-admin
community, while other mature components use Helm
-Charts provided by their official sources. (For more information on how Helm
works, please refer
-to https://helm.sh/zh/docs/)
-
-### DubboConfig YAML (Profile)
-
-DubboConfig YAML and Profile essentially have the same format and field
meanings in YAML configuration files. However,
-they serve different purposes and are kept separate. DubboConfig YAML is
user-facing and represents custom requirements,
-whereas profiles are refined and provided by Dubbo-admin (users can also set
custom profiles) to represent basic
-configurations for different scenarios. Currently, the community offers two
types of profiles: "default" and "demo."
-
-A typical DubboConfig YAML looks like this:
-
-```yaml
-# DubboConfig example
-apiVersion: dubbo.apache.org/v1alpha1
-kind: DubboConfig
-metadata:
- namespace: dubbo-system
-spec:
- # kubectl basic metadata
-
- # Profile specifies the base default configuration to use. If using the
profile provided by Dubbo-admin,
- # you can currently specify either "default" or "demo."
- profile: default
- namespace: dubbo-system
-
- # Metadata for configuring components. For components maintained by
Dubbo-admin, you can configure "enabled,"
- # while other mature components can have repository URLs and Helm Chart
versions.
- componentsMeta:
- # Components maintained by Dubbo-admin
- admin:
- enabled: true
- # Mature components
- grafana:
- enabled: true
- repoURL: https://grafana.github.io/helm-charts
- version: 6.52.4
-
- # Configure each component, where the values in components.admin and
components.grafana fields
- # will be mapped directly to the values.yaml of the respective Helm Chart.
- components:
- admin:
- replicas: 2
- grafana:
- testFramework:
- enabled: true
-```
-
-The default profile is as follows:
-
-```yaml
-apiVersion: dubbo.apache.org/v1alpha1
-kind: DubboOperator
-metadata:
- namespace: dubbo-system
-spec:
- profile: default
- namespace: dubbo-system
- # The default profile launches admin and zookeeper components by default
- componentsMeta:
- admin:
- enabled: true
- zookeeper:
- enabled: true
- repoURL: https://charts.bitnami.com/bitnami
- version: 11.1.6
-```
-
-The demo profile is as follows:
-
-```yaml
-apiVersion: dubbo.apache.org/v1alpha1
-kind: DubboOperator
-metadata:
- namespace: dubbo-system
-spec:
- profile: demo
- namespace: dubbo-system
- # The demo profile launches all components by default
- componentsMeta:
- admin:
- enabled: true
- grafana:
- enabled: true
- repoURL: https://grafana.github.io/helm-charts
- version: 6.52.4
- nacos:
- enabled: true
- zookeeper:
- enabled: true
- repoURL: https://charts.bitnami.com/bitnami
- version: 11.1.6
- prometheus:
- enabled: true
- repoURL: https://prometheus-community.github.io/helm-charts
- version: 20.0.2
- skywalking:
- enabled: true
- repoURL: https://apache.jfrog.io/artifactory/skywalking-helm
- version: 4.3.0
- zipkin:
- enabled: true
- repoURL: https://openzipkin.github.io/zipkin
- version: 0.3.0
-```
-
-You can see that DubboConfig consists of three parts: dubboctl metadata,
componentsMeta, and components. The dubboctl
-metadata can specify the profile, componentsMeta controls the toggles for
components, and mature components can have
-repository addresses and Helm Chart versions specified. Here, let's focus on
components. As mentioned in the manifest
-section, dubboctl uses the Helm API to render Helm Charts, and the values.yaml
required by each chart is derived from
-the field values in the components section. For example, the values in
components.admin will be directly mapped to the
-values.yaml of the Dubbo-kubernetes
-chart
(https://github.com/apache/dubbo-kubernetes/blob/master/deploy/charts/dubbo-admin/values.yaml).
-
-### Overlay
-
-Profiles, as basic configuration items, can be applied over user-defined
DubboConfig YAML using an Overlay mechanism.
-For example, overlaying the DubboConfig YAML example from the previous section
onto the default profile results in:
-
-```yaml
-# DubboConfig example
-apiVersion: dubbo.apache.org/v1alpha1
-kind: DubboConfig
-metadata:
- namespace: dubbo-system
-spec:
- # kubectl basic metadata
-
- # Profile specifies the base default configuration to use. If using the
profile provided by Dubbo-admin,
- # you can currently specify either "default" or "demo."
- profile: default
- namespace: dubbo-system
-
- # Metadata for configuring components. For components maintained by
Dubbo-admin, you can configure "enabled,"
- # while other mature components can have repository URLs and Helm Chart
versions.
- componentsMeta:
- # Components maintained by Dubbo-admin
- admin:
- enabled: true
- # Mature components
- grafana:
- enabled: true
- repoURL: https://grafana.github.io/helm-charts
- version: 6.52.4
- zookeeper:
- enabled: true
- repoURL: https://charts.bitnami.com/bitnami
- version: 11.1.6
-
- # Configure each component, where the values in components.admin and
components.grafana fields
- # will be mapped directly to the values.yaml of the respective Helm Chart.
- components:
- admin:
- replicas: 2
- grafana:
- testFramework:
- enabled: true
-```
-
-Currently, Overlay is implemented using JSON Merge Patch
(https://datatracker.ietf.org/doc/html/rfc7396).
-
-## dubboctl Create
-
-### .dubbo Directory
-
-When you create an application using dubboctl in the correct manner, you'll
notice that a ".dubbo" directory is
-generated. The purpose of this hidden file is to determine whether the
application needs to build an image. If the code
-hasn't been changed, it won't build an image by default unless you include the
"--force" flag.
-
-## dubbo.yaml
-
-dubbo.yaml is a metadata recording file that contains a portion of the data
used by dubboctl when it runs. Some of your
-actions will be recorded in dubbo.yaml, and it takes precedence when you use
\ No newline at end of file
diff --git a/docs/dubboctl/dashboard/dubboctl_dashboard_admin.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_admin.md
deleted file mode 100644
index e0ad385e..00000000
--- a/docs/dubboctl/dashboard/dubboctl_dashboard_admin.md
+++ /dev/null
@@ -1,30 +0,0 @@
-## dubboctl dashboard admin
-
-create PortForward between local address and target component admin pod. open
browser by default
-
-### Synopsis
-
-create PortForward between local address and target component admin pod. open
browser by default
-
-Typical use cases are:
-
-```sh
-
-dubboctl dashboard admin
-
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
-| --port | -p | Set the port for local monitoring connections.
If not set, the default is the same as the Admin dashboard, 8080 | dubboctl
dashboard nacos -p 8848 | No |
-| --host | -h | Set the local host to listen for connections. If
not set, the default is 127.0.0.1 | dubboctl
dashboard nacos -h xxx.xxx.xxx.xxx | No |
-| --openBrowser | | Set whether to automatically open the browser
and open the dashboard, the default is true | dubboctl
dashboard nacos --openBrowser false | No |
-| --namespace | n | Set the namespace where Admin is located. If not
set, the default is dubbo-system. | dubboctl
dashboard nacos -n ns_user_specified | No |
-| --kubeConfig | | The path to store kubeconfig
| dubboctl
dashboard nacos --kubeConfig path/to/kubeConfig | No |
-| --context | | Specify to use the context in kubeconfig
| dubboctl
dashboard nacos --context contextVal | No |
-
-###
-
-### SEE ALSO
-
-* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/dashboard/dubboctl_dashboard_grafana.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_grafana.md
deleted file mode 100644
index 83d5b515..00000000
--- a/docs/dubboctl/dashboard/dubboctl_dashboard_grafana.md
+++ /dev/null
@@ -1,28 +0,0 @@
-## dubboctl dashboard grafana
-
-create PortForward between local address and target component grafana pod.
open browser by default
-
-### Synopsis
-
-create PortForward between local address and target component grafana pod.
open browser by default
-
-Typical use cases are:
-
-```sh
-
-dubboctl dashboard grafana
-
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
-| --port | -p | Set the port for local monitoring connections.
If not set, the default is the same as the Grafana dashboard, 3000 | dubboctl
dashboard nacos -p 8848 | No |
-| --host | -h | Set the local host to listen for connections. If
not set, the default is 127.0.0.1 | dubboctl
dashboard nacos -h xxx.xxx.xxx.xxx | No |
-| --openBrowser | | Set whether to automatically open the browser
and open the dashboard, the default is true | dubboctl
dashboard nacos --openBrowser false | No |
-| --namespace | n | Set the namespace where Grafana is located. If
not set, the default is dubbo-system. | dubboctl
dashboard nacos -n ns_user_specified | No |
-| --kubeConfig | | The path to store kubeconfig
| dubboctl
dashboard nacos --kubeConfig path/to/kubeConfig | No |
-| --context | | Specify to use the context in kubeconfig
| dubboctl
dashboard nacos --context contextVal | No |
-
-### SEE ALSO
-
-* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/dashboard/dubboctl_dashboard_nacos.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_nacos.md
deleted file mode 100644
index 059eb139..00000000
--- a/docs/dubboctl/dashboard/dubboctl_dashboard_nacos.md
+++ /dev/null
@@ -1,28 +0,0 @@
-## dubboctl dashboard nacos
-
-create PortForward between local address and target component nacos pod. open
browser by default
-
-### Synopsis
-
-create PortForward between local address and target component nacos pod. open
browser by default
-
-Typical use cases are:
-
-```sh
-
-dubboctl dashboard nacos
-
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
-| --port | -p | Set the port for local monitoring connections.
If not set, the default is the same as the Nacos dashboard, 3000 | dubboctl
dashboard nacos -p 8848 | No |
-| --host | -h | Set the local host to listen for connections. If
not set, the default is 127.0.0.1 | dubboctl
dashboard nacos -h xxx.xxx.xxx.xxx | No |
-| --openBrowser | | Set whether to automatically open the browser
and open the dashboard, the default is true | dubboctl
dashboard nacos --openBrowser false | No |
-| --namespace | n | Set the namespace where Nacos is located. If not
set, the default is dubbo-system. | dubboctl
dashboard nacos -n ns_user_specified | No |
-| --kubeConfig | | The path to store kubeconfig
| dubboctl
dashboard nacos --kubeConfig path/to/kubeConfig | No |
-| --context | | Specify to use the context in kubeconfig
| dubboctl
dashboard nacos --context contextVal | No |
-
-### SEE ALSO
-
-* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/dashboard/dubboctl_dashboard_prometheus.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_prometheus.md
deleted file mode 100644
index 8e9152e0..00000000
--- a/docs/dubboctl/dashboard/dubboctl_dashboard_prometheus.md
+++ /dev/null
@@ -1,28 +0,0 @@
-## dubboctl dashboard prometheus
-
-create PortForward between local address and target component prometheus pod.
open browser by default
-
-### Synopsis
-
-create PortForward between local address and target component prometheus pod.
open browser by default
-
-Typical use cases are:
-
-```sh
-
-dubboctl dashboard prometheus
-
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
-| --port | -p | Set the port for local monitoring connections.
If not set, the default is the same as the prometheus dashboard, 3000 |
dubboctl dashboard nacos -p 8848 | No |
-| --host | -h | Set the local host to listen for connections. If
not set, the default is 127.0.0.1 | dubboctl
dashboard nacos -h xxx.xxx.xxx.xxx | No |
-| --openBrowser | | Set whether to automatically open the browser
and open the dashboard, the default is true |
dubboctl dashboard nacos --openBrowser false | No |
-| --namespace | n | Set the namespace where prometheus is located.
If not set, the default is dubbo-system. |
dubboctl dashboard nacos -n ns_user_specified | No |
-| --kubeConfig | | The path to store kubeconfig
| dubboctl
dashboard nacos --kubeConfig path/to/kubeConfig | No |
-| --context | | Specify to use the context in kubeconfig
| dubboctl
dashboard nacos --context contextVal | No |
-
-### SEE ALSO
-
-* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/dashboard/dubboctl_dashboard_skywalking.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_skywalking.md
deleted file mode 100644
index 185ec053..00000000
--- a/docs/dubboctl/dashboard/dubboctl_dashboard_skywalking.md
+++ /dev/null
@@ -1,28 +0,0 @@
-## dubboctl dashboard skywalking
-
-create PortForward between local address and target component skywalking pod.
open browser by default
-
-### Synopsis
-
-create PortForward between local address and target component skywalking pod.
open browser by default
-
-Typical use cases are:
-
-```sh
-
-dubboctl dashboard skywalking
-
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
-| --port | -p | Set the port for local monitoring connections.
If not set, the default is the same as the skywalking dashboard, 3000 |
dubboctl dashboard nacos -p 8848 | No |
-| --host | -h | Set the local host to listen for connections. If
not set, the default is 127.0.0.1 | dubboctl
dashboard nacos -h xxx.xxx.xxx.xxx | No |
-| --openBrowser | | Set whether to automatically open the browser
and open the dashboard, the default is true |
dubboctl dashboard nacos --openBrowser false | No |
-| --namespace | n | Set the namespace where skywalking is located.
If not set, the default is dubbo-system. |
dubboctl dashboard nacos -n ns_user_specified | No |
-| --kubeConfig | | The path to store kubeconfig
| dubboctl
dashboard nacos --kubeConfig path/to/kubeConfig | No |
-| --context | | Specify to use the context in kubeconfig
| dubboctl
dashboard nacos --context contextVal | No |
-
-### SEE ALSO
-
-* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/dashboard/dubboctl_dashboard_zipkin.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_zipkin.md
deleted file mode 100644
index 636986ad..00000000
--- a/docs/dubboctl/dashboard/dubboctl_dashboard_zipkin.md
+++ /dev/null
@@ -1,28 +0,0 @@
-## dubboctl dashboard zipkin
-
-create PortForward between local address and target component zipkin pod. open
browser by default
-
-### Synopsis
-
-create PortForward between local address and target component zipkin pod. open
browser by default
-
-Typical use cases are:
-
-```sh
-
-dubboctl dashboard zipkin
-
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
-| --port | -p | Set the port for local monitoring connections.
If not set, the default is the same as the zipkin dashboard, 3000 | dubboctl
dashboard nacos -p 8848 | No |
-| --host | -h | Set the local host to listen for connections. If
not set, the default is 127.0.0.1 | dubboctl
dashboard nacos -h xxx.xxx.xxx.xxx | No |
-| --openBrowser | | Set whether to automatically open the browser
and open the dashboard, the default is true | dubboctl
dashboard nacos --openBrowser false | No |
-| --namespace | n | Set the namespace where zipkin is located. If
not set, the default is dubbo-system. | dubboctl
dashboard nacos -n ns_user_specified | No |
-| --kubeConfig | | The path to store kubeconfig
| dubboctl
dashboard nacos --kubeConfig path/to/kubeConfig | No |
-| --context | | Specify to use the context in kubeconfig
| dubboctl
dashboard nacos --context contextVal | No |
-
-### SEE ALSO
-
-* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/deploy.md b/docs/dubboctl/deploy.md
deleted file mode 100644
index 92f02a2d..00000000
--- a/docs/dubboctl/deploy.md
+++ /dev/null
@@ -1,43 +0,0 @@
-#Deploy
-
-When you use dubboctl to install the required components, we will dynamically
adjust the yaml file generated during the
-deploy phase based on the components you installed. Specifically reflected in
zookeeper, nacos and Prometheus. After you
-install zookeeper, we will add information similar to this to the generated
yaml file:
-
-```yaml
- env:
- - name: zookeeper.address
- value: zookeeper.dubbo-system.svc
- - name: ZOOKEEPER_ADDRESS
- value: zookeeper.dubbo-system.svc
-```
-
-With these, you can use placeholders to read environment variables in your
application to read the address of zookeeper
-without having to fill it in manually, for example:
-
-```yaml
-Dubbo:
- application:
- logger: slf4j
- name: DemoApplication
- registry:
- address: zookeeper://${zookeeper.address:127.0.0.1}:2181
- protocol:
- name: tri
- port: 50051
-
-```
-
-The same goes for nacos.
-
-For Prometheus, we will automatically generate a default list for Prometheus,
which you can modify as needed.
-
-## Advanced
-
-If you installed related components in the dubbo-system namespace. Then the
exact same components are installed in the
-dev namespace, then we will give priority to using the addresses of related
middleware in the dev namespace, and
-everything will be in chronological order. Unless you specify it in an
environment variable:
-
-```sh
-export DUBBO_DEPLOY_NS=dubbo-system
-```
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl.md b/docs/dubboctl/dubboctl.md
deleted file mode 100644
index 67da43ec..00000000
--- a/docs/dubboctl/dubboctl.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-This repository contains libraries and tools for creating and deploying Dubbo
applications in any Kubernetes environment, i.e. on Kubernetes, Aliyun ACK, etc.
-
-## Prerequisites:
-* Ensure you have Go installed, version 1.20 or higher.
-* Make sure you install kubectl.
-* Ensure you have Dubboctl installed.
-
-## Quick Start
-### Create a Dubbo application
-Use `dubboctl create` to create a project template.
-
-```shell
-dubboctl create -l java
-```
-
-This should generate a simple project with a demo service properly configured
and is ready to run.
-
-> For java developers, it's recommended to use [start.dubbo.apache.org]() or
[IntelliJ IDEA plugin]() to generate more complicated templates.
-
-### Deploy application to Kubernetes
-Before deploying the application, let's install Nacos, Zookeeper, Prometheus
and other components necessary for running a Dubbo application or microservice
cluster.
-
-```shell
-dubboctl install --profile=demo # This will install Nacos, Prometheus,
Grafana, Admin, etc.
-```
-
-Next, build your application as docker image and deploy it into kubernetes
cluster with `dubboctl deploy`, it will do the following two steps:
-
-1. Build your application from source code into docker image and push the
image to remote repository.
-2. Generate all the kubernetes configurations (e.g., deployments, services,
load balancers) needed to run your application on vanilla Kubernetes.
-
-```shell
-dubboctl deploy --out=deployment.yml
-```
-
-Finally, apply manifests into kubernetes cluster.
-
-```shell
-kubectl apply -f deployment.yml
-```
diff --git a/docs/dubboctl/dubboctl_build.md b/docs/dubboctl/dubboctl_build.md
deleted file mode 100644
index 2ec79c6e..00000000
--- a/docs/dubboctl/dubboctl_build.md
+++ /dev/null
@@ -1,22 +0,0 @@
-## dubboctl build
-
-Build an application container locally without deploying
-
-### Synopsis
-
- Usage:
- dubboctl build [flags]
-
- Flags:
- -b, --builder-image string Specify a custom builder image for use by the
builder other than its default.
- -e, --envs stringArray environment variable for an application, KEY=VALUE
format
- -f, --force Whether to force push
- -h, --help help for build
- -i, --image string Container image( [registry]/[namespace]/[name]:[tag] )
- -p, --path string Path to the application. Default is current directory
($DUBBO_PATH)
- --push Whether to push the image to the registry center by the way
- -d, --useDockerfile Use the dockerfile with the specified path to build
-
-### SEE ALSO
-
-* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl_create.md b/docs/dubboctl/dubboctl_create.md
deleted file mode 100644
index 5ebb4bca..00000000
--- a/docs/dubboctl/dubboctl_create.md
+++ /dev/null
@@ -1,81 +0,0 @@
-## dubboctl create
-
-Create an application
-
-### Synopsis
-
- dubboctl create [-l|--language] [-t|--template] [-r|--repository]
- [-c|--confirm] [path]
-
-### DESCRIPTION
-
- Creates a new function project.
-
- $ dubboctl create -l go
-
- Creates a function in the current directory '.' which is written in the
- language/runtime 'go' common .
-
- If [path] is provided, the function is initialized at that path,
creating
- the path if necessary.
-
- To complete this command interactively, use --confirm (-c):
- $ dubboctl create -c
-
- To install more language runtimes and their templates see 'dubboctl
repository'.
-
-### EXAMPLES
-
- o Create a Node.js function in the current directory (the default path)
which
- handles http events (the default template).
- $ dubboctl create -l java
-
- o Create a java common in the directory 'myfunc'.
- $ dubboctl create -l java myfunc
-
- o Create a Main common in ./myfunc.
- $ dubboctl create -l go -t common myfunc
-
--t is followed by the warehouse name + application name. If it is the template
provided by dubboctl by default, then
-there is only the application name, which is common. Otherwise, for example,
if the user's warehouse is named ruiyi and
-the application is named mesh, -t should be followed by ruiyi/mesh.
-
-### Usage:
-
- dubboctl create [flags]
-
-### Aliases:
-
- create, init
-
-### Flags:
-
- -c, --confirm Prompt to confirm options interactively
($DUBBO_CONFIRM)
- -h, --help help for create
- -i, --init Initialize the current project directly into a
dubbo project without using a template
- -l, --language string Language Runtime (see help text for list)
($DUBBO_LANGUAGE)
- -r, --repository string URI to a Git repository containing the specified
template ($DUBBO_REPOSITORY)
- -t, --template string Application template. (see help text for list)
($DUBBO_TEMPLATE)
-
-Please note that the languages (runtime) and templates you can use will be
dynamically generated in dubboctl create -h,
-and you can view them, for example:
-
-```sh
-Available Language Runtimes and Templates:
-Language Template
--------- --------
-go common
-go lxy/dubbogo
-go lxy/http
-golang ruiyi/dubbogo
-golang ruiyi/http
-java common
-java lxy/dubbo
-jvav ruiyi/dubbo
-```
-
-Then you can use dubboctl create -l java -t ruiyi/dubbo
-
-### SEE ALSO
-
-* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl_dashboard.md
b/docs/dubboctl/dubboctl_dashboard.md
deleted file mode 100644
index 0fb98de5..00000000
--- a/docs/dubboctl/dubboctl_dashboard.md
+++ /dev/null
@@ -1,29 +0,0 @@
-## dubboctl dashboard
-
-Commands help user to open control plane components dashboards directly. Now
support Admin, Grafana, Nacos, Prometheus,
-Skywalking and Zipkin
-
-### Synopsis
-
-Commands help user to open control plane components dashboards directly. Now
support Admin, Grafana, Nacos, Prometheus,
-Skywalking and Zipkin
-
-```
- -h, --help help for config
-```
-
-### SEE ALSO
-
-* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
-* [dubboctl dashboard admin](dashboard/dubboctl_dashboard_admin.md) - create
PortForward between local address and target
- component admin pod.
-* [dubboctl dashboard grafana](dashboard/dubboctl_dashboard_grafana.md) -
create PortForward between local address and target
- component grafana pod.
-* [dubboctl dashboard nacos](dashboard/dubboctl_dashboard_nacos.md) - create
PortForward between local address and target
- component nacos pod.
-* [dubboctl dashboard prometheus](dashboard/dubboctl_dashboard_prometheus.md)
- create PortForward between local address and
- target component prometheus pod.
-* [dubboctl dashboard skywalking](dashboard/dubboctl_dashboard_skywalking.md)
- create PortForward between local address and
- target component skywalking pod.
-* [dubboctl dashboard zipkin](dashboard/dubboctl_dashboard_zipkin.md) - create
PortForward between local address and target
- component zipkin pod.
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl_deploy.md b/docs/dubboctl/dubboctl_deploy.md
deleted file mode 100644
index 8b17c093..00000000
--- a/docs/dubboctl/dubboctl_deploy.md
+++ /dev/null
@@ -1,42 +0,0 @@
-## dubboctl deploy
-
-Deploy an application
-
-### Synopsis
-
- Usage:
- dubboctl deploy [flags]
-
- Flags:
- -a, --apply Whether to apply the application to the k8s cluster by the way
- -b, --builder-image string Specify a custom builder image for use by the
builder other than its default.
- --containerPort int The port of the deployment to listen on pod (required)
- -e, --envs stringArray Environment variable to set in the form NAME=VALUE.
This is for the environment variables passed
- in by the builderpack build method.
- -f, --force Whether to force push
- -h, --help help for deploy
- -i, --image string Container image( [registry]/[namespace]/[name]:[tag] )
- --imagePullPolicy string The image pull policy of the deployment, default
to IfNotPresent
- --limitCpu int The limit cpu to deploy (default 1000)
- --limitMem int The limit memory to deploy (default 1024)
- --maxReplicas int The max replicas to deploy (default 10)
- --minReplicas int The min replicas to deploy (default 3)
- --name string The name of deployment (required)
- -n, --namespace string Deploy into a specific namespace (default
"dubbo-system")
- --nobuild Skip the step of building the image.
- --nodePort int The nodePort of the deployment to expose
- -o, --output string output kubernetes manifest (default "kube.yaml")
- -p, --path string Path to the application. Default is current directory
($DUBBO_PATH)
- --push Whether to push the image to the registry center by the way
- --replicas int The number of replicas to deploy (default 3)
- --requestCpu int The request cpu to deploy (default 500)
- --requestMem int The request memory to deploy (default 512)
- --revisions int The number of replicas to deploy (default 5)
- --secret string The secret to image pull from registry
- --serviceAccount string TheServiceAccount for the deployment
- --targetPort int The targetPort of the deployment, default to port
- -d, --useDockerfile Use the dockerfile with the specified path to build
-
-### SEE ALSO
-
-* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl_env.md b/docs/dubboctl/dubboctl_env.md
deleted file mode 100644
index a1bb1c90..00000000
--- a/docs/dubboctl/dubboctl_env.md
+++ /dev/null
@@ -1,48 +0,0 @@
-## Use of environment variables in projects
-
-Among the common commands create, repository, build and deploy. We will see
that there are many flags. For example, the
-deploy flags are as follows:
-
-```sh
- -a, --apply Whether to apply the application to the k8s cluster by the way
- -b, --builder-image string Specify a custom builder image for use by the
builder other than its default.
- --containerPort int The port of the deployment to listen on pod
(required)
- -e, --envs stringArray Environment variable to set in the form NAME=VALUE.
This is for the environment variables passed in by the builderpack build method.
- -f, --force Whether to force push
- -h, --help help for deploy
- -i, --image string Container image( [registry]/[namespace]/[name]:[tag] )
- --imagePullPolicy string The image pull policy of the deployment,
default to IfNotPresent
- --limitCpu int The limit cpu to deploy (default 1000)
- --limitMem int The limit memory to deploy (default 1024)
- --maxReplicas int The max replicas to deploy (default 10)
- --minReplicas int The min replicas to deploy (default 3)
- --name string The name of deployment (required)
- -n, --namespace string Deploy into a specific namespace (default
"dubbo-system")
- --nobuild Skip the step of building the image.
- --nodePort int The nodePort of the deployment to expose
- -o, --output string output kubernetes manifest (default "kube.yaml")
- -p, --path string Path to the application. Default is current directory
($DUBBO_PATH)
- --push Whether to push the image to the registry center by the way
- --replicas int The number of replicas to deploy (default 3)
- --requestCpu int The request cpu to deploy (default 500)
- --requestMem int The request memory to deploy (default 512)
- --revisions int The number of replicas to deploy (default 5)
- --secret string The secret to image pull from registry
- --serviceAccount string TheServiceAccount for the deployment
- --targetPort int The targetPort of the deployment, default to port
- -d, --useDockerfile Use the dockerfile with the specified path to build
-```
-
-We can add it to the environment variable with the prefix of `DUBBO_` and the
non-abbreviated notation of flags in all
-capital letters. Subsequent operations will give priority to the value in the
environment variable. The priority order
-from large to small is: environment variables, command line flags, dubbo.yaml.
-
-As an example:
-
-```sh
-export DUBBO_PUSH=true
-```
-
-Add the --push flag to the environment variables
-
-Therefore, future operations PUSH will always be true unless the setting of
the environment variable is cancelled.
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl_help.md b/docs/dubboctl/dubboctl_help.md
deleted file mode 100644
index 1c681708..00000000
--- a/docs/dubboctl/dubboctl_help.md
+++ /dev/null
@@ -1,21 +0,0 @@
-## dubboctl
-
-dubbo control interface
-
-### Synopsis
-
-dubbo control interface
-
-```
- -h, --help help for config
-```
-
-### SEE ALSO
-
-* [dubboctl manifest](manifest/dubboctl_manifest.md) - Commands help user to
generate manifest and install manifest
-* [dubboctl profile](profile/dubboctl_profile.md) - Commands help user to list
and describe profiles
-* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
-* [dubboctl repository](repository/dubboctl_repository.md) - Manage set of
installed repositories.
-* [dubboctl create](dubboctl_create.md) - Create an application
-* [dubboctl build](dubboctl_build.md) - Build an application container locally
without deploying
-* [dubboctl deploy](dubboctl_deploy.md) - Deploy an application
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl_structure.md
b/docs/dubboctl/dubboctl_structure.md
deleted file mode 100644
index e0788f59..00000000
--- a/docs/dubboctl/dubboctl_structure.md
+++ /dev/null
@@ -1,121 +0,0 @@
-# How to Customize and Build a Template
-
-You can refer to this project: https://github.com/sjmshsh/dubboctl-samples
-
-Here's the directory structure for `dubboctl-samples`:
-
-```
-shCopy code.
-├── go
-│ ├── grpc
-│ │ ├── api
-│ │ │ ├── generate.sh
-│ │ │ ├── samples_api.pb.go
-│ │ │ ├── samples_api.proto
-│ │ │ └── samples_api_triple.pb.go
-│ │ ├── cmd
-│ │ │ └── client.go
-│ │ ├── conf
-│ │ │ └── dubbogo.yml
-│ │ └── go.mod
-│ └── mesh
-│ ├── api
-│ │ ├── generate.sh
-│ │ ├── samples_api.pb.go
-│ │ ├── samples_api.proto
-│ │ └── samples_api_triple.pb.go
-│ ├── cmd
-│ │ └── client.go
-│ ├── conf
-│ │ └── dubbogo.yml
-│ └── go.mod
-└── java
- ├── metrics
- │ ├── case-configuration.yml
- │ ├── case-versions.conf
- │ ├── pom.xml
- │ ├── README.md
- │ └── src
- │ ├── main
- │ │ ├── java
- │ │ │ └── org
- │ │ │ └── apache
- │ │ │ └── dubbo
- │ │ │ └── samples
- │ │ │ └── metrics
- │ │ │ ├── api
- │ │ │ │ └── DemoService.java
- │ │ │ ├── EmbeddedZooKeeper.java
- │ │ │ ├── impl
- │ │ │ │ └── DemoServiceImpl.java
- │ │ │ ├── MetricsConsumer.java
- │ │ │ ├── MetricsProvider.java
- │ │ │ └── model
- │ │ │ ├── Result.java
- │ │ │ └── User.java
- │ │ └── resources
- │ │ ├── log4j.properties
- │ │ └── spring
- │ │ ├── dubbo-demo-consumer.xml
- │ │ └── dubbo-demo-provider.xml
- │ └── test
- │ └── java
- │ └── org
- │ └── apache
- │ └── dubbo
- │ └── samples
- │ └── metrics
- │ └── MetricsServiceIT.java
- └── spring-xml
- ├── case-configuration.yml
- ├── case-versions.conf
- ├── pom.xml
- └── src
- ├── main
- │ ├── java
- │ │ └── org
- │ │ └── apache
- │ │ └── dubbo
- │ │ └── samples
- │ │ ├── api
- │ │ │ └── GreetingsService.java
- │ │ ├── client
- │ │ │ ├── AlwaysApplication.java
- │ │ │ └── Application.java
- │ │ └── provider
- │ │ ├── Application.java
- │ │ └── GreetingsServiceImpl.java
- │ └── resources
- │ ├── log4j.properties
- │ └── spring
- │ ├── dubbo-demo-consumer.xml
- │ └── dubbo-demo-provider.xml
- └── test
- └── java
- └── org
- └── apache
- └── dubbo
- └── samples
- └── test
- └── GreetingsServiceIT.java
-```
-
-In a nutshell:
-
-```
-shCopy code.
-├── go
-│ ├── grpc
-│ └── mesh
-└── java
- ├── metrics
- └── spring-xml
-```
-
-"go" and "java" represent your runtime language. "grpc," "mesh," "metrics,"
and "spring-xml" are the application names.
-The specific template code should be written in the "grpc," "mesh," "metrics,"
or "spring-xml" directories.
-
-Now that you've customized and built your template, you can proceed to read
the instructions in the dubboctl repository
-on how to add your custom-built template to the repository.
-
-This guide should help you understand the structure and process in a
straightforward manner.
\ No newline at end of file
diff --git a/docs/dubboctl/manifest/dubboctl_manifest.md
b/docs/dubboctl/manifest/dubboctl_manifest.md
deleted file mode 100644
index 48c98a79..00000000
--- a/docs/dubboctl/manifest/dubboctl_manifest.md
+++ /dev/null
@@ -1,23 +0,0 @@
-## dubboctl manifest
-
-Commands help user to generate manifest and install manifest
-
-### Synopsis
-
-Commands help user to generate manifest and install manifest
-
-```
- -h, --help help for config
-```
-
-### SEE ALSO
-
-* [dubboctl](../reference/dubboctl.md) - Management tool for dubbo-kubernetes
-* [dubboctl manifest diff](dubboctl_manifest_diff.md) - show the difference
between two files or dirs
-* [dubboctl manifest generate](dubboctl_manifest_generate.md) - Generate the
manifest of the required components.
-* [dubboctl manifest install](dubboctl_manifest_install.md) - Install the
required components directly to the k8s
- cluster.
-* [dubboctl manifest uninstall](dubboctl_manifest_uninstall.md) - Uninstall
the specified component. Unconditional
- uninstallation is currently not supported (this means that users cannot
force deletion if they do not know the
- DubboConfig yaml or set parameters used in dubboctl manifest intall, and
need to use kubectl and other tools to delete
- it).
\ No newline at end of file
diff --git a/docs/dubboctl/manifest/dubboctl_manifest_diff.md
b/docs/dubboctl/manifest/dubboctl_manifest_diff.md
deleted file mode 100644
index 8c00f36d..00000000
--- a/docs/dubboctl/manifest/dubboctl_manifest_diff.md
+++ /dev/null
@@ -1,24 +0,0 @@
-## dubboctl manifest diff
-
-show the difference between two files or dirs
-
-### Synopsis
-
-Show the differences between the two manifests, split the manifest into
multiple k8s objects, compare objects with the
-same namespace:kind:name, and output the redundant objects and objects with
parsing errors in the manifest; if you show
-the differences between the two directories , perform the above processing on
manifests with the same name, and output
-the redundant manifests in the directory and the manifests with parsing errors.
-
-Typical use cases are:
-
-```sh
-dubboctl manifest diff path/to/file0 path/to/file1
-```
-
-| parameter | shorthand | describe | Example
| required |
-|--------------|-----------|--------------------------------------|---------------------------------------------------------------|----------|
-| --compareDir | | Compare manifests in two directories | dubboctl
manifest diff path/to/dir0 path/to/dir1 --compareDir | No |
-
-### SEE ALSO
-
-* [dubboctl manifest](dubboctl_manifest.md) - Commands help user to generate
manifest and install manifest
diff --git a/docs/dubboctl/manifest/dubboctl_manifest_generate.md
b/docs/dubboctl/manifest/dubboctl_manifest_generate.md
deleted file mode 100644
index 326580cc..00000000
--- a/docs/dubboctl/manifest/dubboctl_manifest_generate.md
+++ /dev/null
@@ -1,26 +0,0 @@
-## dubboctl manifest diff generate
-
-Generate the manifest of the required components.
-
-### Synopsis
-
-Generate the manifest of the required components.
-Typical use cases are:
-
-```sh
-dubboctl manifest generate | kubectl apply -f -
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|--------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|----------|
-| --filenames | -f | Specify one or more user-defined DubboConfig yaml
paths. When parsing, follow the order from left to right. Overlay
| dubboctl manifest generate -f path/to/file0.yaml,
path/to/file1.yaml | No |
-| --charts | | The directory where Helm Charts are stored. If
the user does not specify it, /deploy/charts is used by default
| dubboctl manifest generate --charts
path/to/charts |
No |
-| --profiles | | The directory where profiles are stored. If the
user does not specify it, /deploy/profiles is used by default
| dubboctl manifest generate --profiles
path/to/profiles | No
|
-| --set | -s | Set one or more key-value pairs in DubboConfig
yaml. The priority is set flags > user-defined DubboConfig yaml > profile. It
is recommended not to use set | dubboctl manifest generate --set
components.admin.replicas=2,components in production. admin.rbac.enabled=false
| No |
-| --kubeConfig | | The path where kubeconfig is stored
| dubboctl manifest generate --kubeConfig
path/to/kubeConfig | No
|
-| --context | | Specify the context in kubeconfig
| dubboctl manifest generate --context contextVal
| No |
-| --output | -o | Specify the output path for the final generated
manifest. If not set, the output will be output to the console by default
| dubboctl manifest generate -o
path/to/target/directory
| No |
-
-### SEE ALSO
-
-* [dubboctl manifest](dubboctl_manifest.md) - Commands help user to generate
manifest and install manifest
diff --git a/docs/dubboctl/manifest/dubboctl_manifest_install.md
b/docs/dubboctl/manifest/dubboctl_manifest_install.md
deleted file mode 100644
index 91b3a849..00000000
--- a/docs/dubboctl/manifest/dubboctl_manifest_install.md
+++ /dev/null
@@ -1,25 +0,0 @@
-## dubboctl manifest install
-
-Install the required components directly to the k8s cluster.
-
-### Synopsis
-
-Install the required components directly to the k8s cluster.
-Typical use cases are:
-
-```sh
-dubboctl manifset install
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|----------|
-| --filenames | -f | Specify one or more user-defined DubboConfig
yaml paths, and overlay them in order from left to right when parsing.
| dubboctl manifest install -f
path/to/file0.yaml, path/to/file1.yaml | No |
-| --charts | | The directory where Helm Charts are stored. If
the user does not specify it, /deploy/charts is used by default.
| dubboctl manifest install
--charts path/to/charts | No
|
-| --profiles | | The directory where profiles are stored. If the
user does not specify it, /deploy/profiles is used by default.
| dubboctl manifest install
--profiles path/to/profiles | No
|
-| --set | -s | Set one or more key-value pairs in DubboConfig
yaml. The priority is set flags > profile > user-defined DubboOperator yaml. It
is recommended not to use set in production. | dubboctl manifest install --set
components.admin.replicas=2,components.admin.rbac.enabled=false | 否 |
-| --ku beConfig | | The path to store kubeconfig
| dubboctl manifest install
--kubeConfig path/to/kubeConfig | No
|
-| --context | | Specify to use the context in kubeconfig
| dubboctl manifest install
--context contextVal | No
|
-
-### SEE ALSO
-
-* [dubboctl manifest](dubboctl_manifest.md) - Commands help user to generate
manifest and install manifest
diff --git a/docs/dubboctl/manifest/dubboctl_manifest_uninstall.md
b/docs/dubboctl/manifest/dubboctl_manifest_uninstall.md
deleted file mode 100644
index e88e48a6..00000000
--- a/docs/dubboctl/manifest/dubboctl_manifest_uninstall.md
+++ /dev/null
@@ -1,27 +0,0 @@
-## dubboctl manifest uninstall
-
-uninstall dubbo control plane
-
-### Synopsis
-
-Uninstall the specified component. Unconditional uninstallation is currently
not supported (this means that users cannot
-force deletion if they do not know the DubboConfig yaml or set parameters used
in dubboctl manifest intall, and need to
-use kubectl and other tools to delete it).
-Typical use cases are:
-
-```sh
-dubboctl manifest uninstall
-```
-
-| parameter | shorthand | describe
| Example
| required |
-|---------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|----------|
-| --filenames | -f | Specify one or more user-defined DubboConfig
yaml paths, and overlay them in order from left to right when parsing.
| dubboctl manifest install -f
path/to/file0.yaml, path/to/file1.yaml | No |
-| --charts | | The directory where Helm Charts are stored. If
the user does not specify it, /deploy/charts is used by default.
| dubboctl manifest install
--charts path/to/charts | No
|
-| --profiles | | The directory where profiles are stored. If the
user does not specify it, /deploy/profiles is used by default.
| dubboctl manifest install
--profiles path/to/profiles | No
|
-| --set | -s | Set one or more key-value pairs in DubboConfig
yaml. The priority is set flags > profile > user-defined DubboOperator yaml. It
is recommended not to use set in production. | dubboctl manifest install --set
components.admin.replicas=2,components.admin.rbac.enabled=false | 否 |
-| --ku beConfig | | The path to store kubeconfig
| dubboctl manifest install
--kubeConfig path/to/kubeConfig | No
|
-| --context | | Specify to use the context in kubeconfig
| dubboctl manifest install
--context contextVal | No
|
-
-### SEE ALSO
-
-* [dubboctl manifest](dubboctl_manifest.md) - Commands help user to generate
manifest and install manifest
diff --git a/docs/dubboctl/profile/dubboctl_profile.md
b/docs/dubboctl/profile/dubboctl_profile.md
deleted file mode 100644
index 766c36f8..00000000
--- a/docs/dubboctl/profile/dubboctl_profile.md
+++ /dev/null
@@ -1,17 +0,0 @@
-## dubboctl profile
-
-Commands help user to list and describe profiles
-
-### Synopsis
-
-Commands help user to list and describe profiles
-
-```
- -h, --help help for config
-```
-
-### SEE ALSO
-
-* [dubboctl](../reference/dubboctl.md) - Management tool for dubbo-kubernetes
-* [dubboctl profile diff](dubboctl_profile_diff.md) - Show the difference
between two profiles
-* [dubboctl profile list](dubboctl_profile_list.md) - List all existing
profiles specification
diff --git a/docs/dubboctl/profile/dubboctl_profile_diff.md
b/docs/dubboctl/profile/dubboctl_profile_diff.md
deleted file mode 100644
index a526c3f1..00000000
--- a/docs/dubboctl/profile/dubboctl_profile_diff.md
+++ /dev/null
@@ -1,22 +0,0 @@
-## dubboctl profile diff
-
-Show the difference between two profiles
-
-### Synopsis
-
-Show the difference between two profiles
-Typical use cases are:
-
-```sh
-
-dubboctl profile diff default demo
-
-```
-
-| parameter | shorthand | describe |
Example | required |
-|------------|-----------|-------------------------------------------------|---------------------------------------------------|----------|
-| --profiles | | Specify the directory where profiles are stored |
dubboctl profile list --profiles path/to/profiles | No |
-
-### SEE ALSO
-
-* [dubboctl profile](dubboctl_profile.md) - Commands help user to list and
describe profiles
diff --git a/docs/dubboctl/profile/dubboctl_profile_list.md
b/docs/dubboctl/profile/dubboctl_profile_list.md
deleted file mode 100644
index 94c7b031..00000000
--- a/docs/dubboctl/profile/dubboctl_profile_list.md
+++ /dev/null
@@ -1,22 +0,0 @@
-## dubboctl profile list
-
-List all existing profiles specification
-
-### Synopsis
-
-Displays which profiles are in the profiles directory and displays the content
of the specified profile.
-Typical use cases are:
-
-```sh
-dubboctl profile list
-
-dubboctl profile list default
-```
-
-| parameter | shorthand | describe |
Example | required |
-|------------|-----------|-------------------------------------------------|---------------------------------------------------|----------|
-| --profiles | | Specify the directory where profiles are stored |
dubboctl profile list --profiles path/to/profiles | No |
-
-### SEE ALSO
-
-* [dubboctl profile](dubboctl_profile.md) - Commands help user to list and
describe profiles
diff --git a/docs/dubboctl/quick_start.md b/docs/dubboctl/quick_start.md
deleted file mode 100644
index b337cadb..00000000
--- a/docs/dubboctl/quick_start.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# Quick start
-
-## Install components
-
-Follow the components required by the dubbo project, such as admin and
zookeeper.
-
-```sh
-dubboctl manifest install
-```
-
-## Initialize dubbo project
-
-```sh
-dubboctl create -l java
-```
-
-Initialize a java project in the current directory using the default template
provided by dubboctl. Please make sure the
-current directory is an empty directory.
-
-> When writing your business logic, please note that the address of your
configuration file needs to be filled in
-> correctly, such as the address of zookeeper, and when deploying below, the
containerPort needs to be consistent with
-> the
-> port exposed by your application to allow the program to run normally.
-
-## Deploy to k8s
-
-```sh
-dubboctl deploy --containerPort 20000 --push --image
docker.io/testuser/testdubbo:latest --apply
-```
-
-> If you do not plan to deploy the application to k8s, please use the build
command to build the image and replace the
-> third step with
->
-> ```sh
-> dubboctl build --push --image docker.io/testuser/testdubbo:latest
-> ```
\ No newline at end of file
diff --git a/docs/dubboctl/repository/dubboctl_repository.md
b/docs/dubboctl/repository/dubboctl_repository.md
deleted file mode 100644
index a08fa202..00000000
--- a/docs/dubboctl/repository/dubboctl_repository.md
+++ /dev/null
@@ -1,136 +0,0 @@
-## dubboctl repository
-
-Manage set of installed repositories.
-
-### Synopsis
-
- dubboctl repo [-c|--confirm]
- dubboctl repo list [-r|--repositories] [-c|--confirm]
- dubboctl repo add <name> <url>[-r|--repositories] [-c|--confirm]
- dubboctl repo rename <old> <new> [-r|--repositories] [-c|--confirm]
- dubboctl repo remove <name> [-r|--repositories] [-c|--confirm]
-
-### Description
-
- Manage template repositories installed on disk at either the default
location
- (~/.config/dubbo/repositories) or the location specified by the
--repository
- flag. Once added, a template from the repository can be used when
creating
- a new Dubbo.
-
- Interactive Prompts:
- To complete these commands interactively, pass the --confirm (-c) flag
to
- the 'repository' command, or any of the inidivual subcommands.
-
- The Default Repository:
- The default repository is not stored on disk, but embedded in the
binary and
- can be used without explicitly specifying the name. The default
repository
- is always listed first, and is assumed when creating a new function
without
- specifying a repository name prefix.
- For example, to create a new one using the 'common' template from the
- default repository.
- $ dubboctl create -l go -t common
-
- The Repository Flag:
- Installing repositories locally is optional. To use a template from a
remote
- repository directly, it is possible to use the --repository flag on
create.
- This leaves the local disk untouched. For example, To create a
scaffold using
- the dubboctl-samples http template without installing the template
- repository locally, use the --repository (-r) flag on create:
- $ dubboctl create -l go \
- --template http \
- --repository https://github.com/sjmshsh/dubboctl-samples
-
- Alternative Repositories Location:
- Repositories are stored on disk in ~/.config/dubbo/repositories by
default.
- This location can be altered by setting the DUBBO_REPOSITORIES_PATH
- environment variable.
-
-### COMMANDS
-
- With no arguments, this help text is shown. To manage repositories with
- an interactive prompt, use the use the --confirm (-c) flag.
- $ dubboctl repository -c
-
- add
- Add a new repository to the installed set.
- $ dubboctl repository add <name> <URL>
-
- For Example, to add the ruiyi Project repository:
- $ dubboctl repository add ruiyi
https://github.com/sjmshsh/dubboctl-samples
-
- Once added, a function can be created with templates from the new
repository
- by prefixing the template name with the repository. For example, to
create
- a new function using the dubbogo template:
- $ dubboctl create -l go -t ruiyi/dubbogo
-
- list
- List all available repositories, including the installed default
- repository. Repositories available are listed by name.
-
- rename
- Rename a previously installed repository from <old> to <new>. Only
installed
- repositories can be renamed.
- $ dubboctl repository rename <name> <new name>
-
- remove
- Remove a repository by name. Removes the repository from local
storage
- entirely. When in confirm mode (--confirm) it will confirm before
- deletion, but in regular mode this is done immediately, so please use
- caution, especially when using an altered repositories location
- (via the DUBBO_REPOSITORIES_PATH environment variable).
- $ dubboctl repository remove <name>
-
-### EXAMPLES
-
- o Run in confirmation mode (interactive prompts) using the --confirm flag
- $ dubboctl repository -c
-
- o Add a repository and create a new function using a template from it:
- $ dubboctl repository add ruiyi
https://github.com/sjmshsh/dubboctl-samples
- $ dubboctl repository list
- default
- functastic
- $ dubboctl create -l go -t ruiyi/dubbogo
- ...
-
- o Add a repository specifying the branch to use (dubboctl):
- $ dubboctl repository add ruiyi
https://github.com/sjmshsh/dubboctl-samples#dubboctl
- $ dubboctl repository list
- default
- ruiyi
- $ dubboctl create -l go -t http
- ...
-
- o List all repositories including the URL from which remotes were
installed
- $ dubboctl repository list -v
- default
- master https://github.com/sjmshsh/dubboctl-samples#master
-
- o Rename an installed repository
- $ dubboctl repository list
- default
- ruiyi
- $ dubboctl repository rename ruiyi dubboTest
- $ dubboctl repository list
- default
- dubboTest
-
- o Remove an installed repository
- $ dubboctl repository list
- default
- dubboTest
- $ dubboctl repository remove dubboTest
- $ dubboctl repository list
- default
-
-Flags:
--c, --confirm Prompt to confirm options interactively ($DUBBO_CONFIRM)
--h, --help help for repository
-
-### SEE ALSO
-
-* [dubboctl](../reference/dubboctl.md) - Management tool for dubbo-kubernetes
-* [dubboctl repository add](dubboctl_repository_add.md)
-* [dubboctl repository list](dubboctl_repository_add.md)
-* [dubboctl repository remove](dubboctl_repository_remove.md)
-* [dubboctl repository rename](dubboctl_repository_rename.md)
diff --git a/docs/dubboctl/repository/dubboctl_repository_add.md
b/docs/dubboctl/repository/dubboctl_repository_add.md
deleted file mode 100644
index 95536a72..00000000
--- a/docs/dubboctl/repository/dubboctl_repository_add.md
+++ /dev/null
@@ -1,17 +0,0 @@
-## dubboctl repository add
-
-Manage set of installed repositories.
-
-### Synopsis
-
-Usage:
-dubboctl repository add <name> <url> [flags]
-
-Flags:
--c, --confirm Prompt to confirm options interactively ($DUBBO_CONFIRM)
--h, --help help for add
-
-### SEE ALSO
-
-* [dubboctl repository](dubboctl_repository.md) - Manage set of installed
repositories.
-
diff --git a/docs/dubboctl/repository/dubboctl_repository_list.md
b/docs/dubboctl/repository/dubboctl_repository_list.md
deleted file mode 100644
index 12393b80..00000000
--- a/docs/dubboctl/repository/dubboctl_repository_list.md
+++ /dev/null
@@ -1,20 +0,0 @@
-## dubboctl repository list
-
-Manage set of installed repositories.
-
-### Synopsis
-
-Usage:
-dubboctl repository list [flags]
-
-Aliases:
-list, ls
-
-Flags:
--c, --confirm Prompt to confirm options interactively ($DUBBO_CONFIRM)
--h, --help help for list
-
-### SEE ALSO
-
-* [dubboctl repository](dubboctl_repository.md) - Manage set of installed
repositories.
-
diff --git a/docs/dubboctl/repository/dubboctl_repository_remove.md
b/docs/dubboctl/repository/dubboctl_repository_remove.md
deleted file mode 100644
index 5ee33e8b..00000000
--- a/docs/dubboctl/repository/dubboctl_repository_remove.md
+++ /dev/null
@@ -1,20 +0,0 @@
-## dubboctl repository remove
-
-Manage set of installed repositories.
-
-### Synopsis
-
-Usage:
-dubboctl repository remove <name> [flags]
-
-Aliases:
-remove, rm
-
-Flags:
--c, --confirm Prompt to confirm options interactively ($DUBBO_CONFIRM)
--h, --help help for remove
-
-### SEE ALSO
-
-* [dubboctl repository](dubboctl_repository.md) - Manage set of installed
repositories.
-
diff --git a/docs/dubboctl/repository/dubboctl_repository_rename.md
b/docs/dubboctl/repository/dubboctl_repository_rename.md
deleted file mode 100644
index de00689e..00000000
--- a/docs/dubboctl/repository/dubboctl_repository_rename.md
+++ /dev/null
@@ -1,20 +0,0 @@
-## dubboctl repository rename
-
-Manage set of installed repositories.
-
-### Synopsis
-
-Usage:
-dubboctl repository rename <old> <new> [flags]
-
-Aliases:
-rename, mv
-
-Flags:
--c, --confirm Prompt to confirm options interactively ($DUBBO_CONFIRM)
--h, --help help for rename
-
-### SEE ALSO
-
-* [dubboctl repository](dubboctl_repository.md) - Manage set of installed
repositories.
-
diff --git a/docs/generated/policies.md b/docs/generated/policies.md
deleted file mode 100644
index de0911af..00000000
--- a/docs/generated/policies.md
+++ /dev/null
@@ -1,17 +0,0 @@
-## How to generate a new Dubbo policy
-
-Use the tool:
-
-```shell
-go run ./tools/policy-gen/bootstrap/... --name CaseNameOfPolicy
-```
-
-The output of the tool will tell you where the important files are!
-
-## Add plugin name to the configuration
-
-To enable policy you need to adjust configuration of two places:
-* Remove `+dubbo:policy:skip_registration=true` from your policy schema.
-* Add import in `pkg/plugins/policies/imports.go`
-* `pkg/plugins/policies/core/ordered/ordered.go`. Plugins name is equals to
`DubboctlArg` in file `zz_generated.resource.go`. It's important to place the
plugin in the correct place because the order of executions is important.
-
diff --git a/docs/static/README.md b/docs/static/README.md
deleted file mode 100644
index 02893ed2..00000000
--- a/docs/static/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Images
-
-The directory is for storing images related to the project.
\ No newline at end of file
diff --git a/docs/static/images/homepage/arch1.png
b/docs/static/images/homepage/arch1.png
deleted file mode 100644
index 4839b73e..00000000
Binary files a/docs/static/images/homepage/arch1.png and /dev/null differ
diff --git a/docs/static/images/homepage/arch2.png
b/docs/static/images/homepage/arch2.png
deleted file mode 100644
index 965ae57e..00000000
Binary files a/docs/static/images/homepage/arch2.png and /dev/null differ
diff --git a/docs/static/images/homepage/kubernetes-mode.png
b/docs/static/images/homepage/kubernetes-mode.png
deleted file mode 100644
index 87cf28b5..00000000
Binary files a/docs/static/images/homepage/kubernetes-mode.png and /dev/null
differ
diff --git a/docs/static/images/homepage/multiple-cluster.png
b/docs/static/images/homepage/multiple-cluster.png
deleted file mode 100644
index f92def9e..00000000
Binary files a/docs/static/images/homepage/multiple-cluster.png and /dev/null
differ
diff --git a/docs/static/images/homepage/ui-demo.png
b/docs/static/images/homepage/ui-demo.png
deleted file mode 100644
index 0e627163..00000000
Binary files a/docs/static/images/homepage/ui-demo.png and /dev/null differ
diff --git a/docs/static/images/homepage/universal-mode.png
b/docs/static/images/homepage/universal-mode.png
deleted file mode 100644
index 63b13b0a..00000000
Binary files a/docs/static/images/homepage/universal-mode.png and /dev/null
differ
diff --git a/docs/static/images/ide_configuration.png
b/docs/static/images/ide_configuration.png
deleted file mode 100644
index 83df9965..00000000
Binary files a/docs/static/images/ide_configuration.png and /dev/null differ
diff --git a/docs/static/images/index.png b/docs/static/images/index.png
deleted file mode 100644
index f23bc1aa..00000000
Binary files a/docs/static/images/index.png and /dev/null differ
diff --git a/docs/static/images/logo.png b/docs/static/images/logo.png
deleted file mode 100644
index 0951ed5e..00000000
Binary files a/docs/static/images/logo.png and /dev/null differ
diff --git a/docs/static/images/profile-eclipse.jpg
b/docs/static/images/profile-eclipse.jpg
deleted file mode 100644
index ee7621f0..00000000
Binary files a/docs/static/images/profile-eclipse.jpg and /dev/null differ
diff --git a/docs/static/images/profile-idea.jpg
b/docs/static/images/profile-idea.jpg
deleted file mode 100644
index 834d9f06..00000000
Binary files a/docs/static/images/profile-idea.jpg and /dev/null differ
diff --git a/job.yaml b/job.yaml
deleted file mode 100644
index 49ba707f..00000000
--- a/job.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-{{- $jobs := .Values.jobs -}}
-apiVersion: batch/v1
-kind: Job
-metadata:
- name: extra-job-create
- namespace: {{ template "admin.namespace" . }}
- labels:
- {{- include "jobs.labels" . | nindent 4 }}
- annotations:
- "helm.sh/hook": "pre-install"
- "helm.sh/hook-weight": "1"
- "helm.sh/hook-delete-policy": "hook-succeeded"
-spec:
- template:
- metadata:
- name: extra-job-create
- spec:
- restartPolicy: {{ $jobs.restartPolicy }}
- dnsPolicy: None
- dnsConfig:
- nameservers:
- - 8.8.8.8
- searches:
- - svc.cluster.local
- - cluster.local
- containers:
- - name: helm
- image: alpine/helm:3.16.2
- imagePullPolicy: IfNotPresent
- command:
- - "/bin/sh"
- - "-c"
- - "sh /files/helm.sh"
- volumeMounts:
- - name: scripts
- mountPath: /files/helm.sh
- subPath: helm.sh
- - name: scripts
- mountPath: /files/resources/dubbo-metrics.yaml
- subPath: dubbo-metrics.yaml
- volumes:
- - name: scripts
- configMap:
- name: {{ include "job.name" . }}-config
- defaultMode: 0755
\ No newline at end of file
diff --git a/operator/pkg/helm/helm.go b/operator/pkg/helm/helm.go
index 16f9b96c..60429cbc 100644
--- a/operator/pkg/helm/helm.go
+++ b/operator/pkg/helm/helm.go
@@ -21,7 +21,6 @@ import (
"fmt"
"github.com/apache/dubbo-kubernetes/manifests"
"github.com/apache/dubbo-kubernetes/operator/pkg/manifest"
- "github.com/apache/dubbo-kubernetes/operator/pkg/parts"
"github.com/apache/dubbo-kubernetes/operator/pkg/util"
"github.com/apache/dubbo-kubernetes/operator/pkg/values"
"github.com/apache/dubbo-kubernetes/pkg/util/slices"
@@ -94,13 +93,13 @@ func renderChart(namespace string, chrtVals values.Map,
chrt *chart.Chart) ([]st
sort.Strings(keys)
res := make([]string, 0, len(keys))
for _, k := range keys {
- res = append(res, parts.SplitString(files[k])...)
+ res = append(res, util.SplitString(files[k])...)
}
slices.SortBy(crdFiles, func(a chart.CRD) string {
return a.Name
})
for _, crd := range crdFiles {
- res = append(res, parts.SplitString(string(crd.File.Data))...)
+ res = append(res, util.SplitString(string(crd.File.Data))...)
}
return res, warnings, nil
}
diff --git a/operator/pkg/manifest/manifest.go
b/operator/pkg/manifest/manifest.go
index 4f650358..606b1f77 100644
--- a/operator/pkg/manifest/manifest.go
+++ b/operator/pkg/manifest/manifest.go
@@ -20,7 +20,7 @@ package manifest
import (
"encoding/json"
"github.com/apache/dubbo-kubernetes/operator/pkg/component"
- "github.com/apache/dubbo-kubernetes/operator/pkg/parts"
+ "github.com/apache/dubbo-kubernetes/operator/pkg/util"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/yaml"
)
@@ -48,7 +48,7 @@ func FromObject(us *unstructured.Unstructured) (Manifest,
error) {
// ParseMultiple splits a string containing potentially many YAML objects, and
parses them.
func ParseMultiple(output string) ([]Manifest, error) {
- return Parse(parts.SplitString(output))
+ return Parse(util.SplitString(output))
}
// Parse parses a list of YAML objects.
diff --git a/operator/pkg/parts/parts.go b/operator/pkg/util/parts.go
similarity index 99%
rename from operator/pkg/parts/parts.go
rename to operator/pkg/util/parts.go
index 204a93d6..40ba85f7 100644
--- a/operator/pkg/parts/parts.go
+++ b/operator/pkg/util/parts.go
@@ -15,7 +15,7 @@
* limitations under the License.
*/
-package parts
+package util
import (
"bufio"
diff --git a/traffic/authority.yaml b/traffic/authority.yaml
deleted file mode 100644
index d76919eb..00000000
--- a/traffic/authority.yaml
+++ /dev/null
@@ -1,28 +0,0 @@
-{{- $auth := .Values.auth -}}{{- $authz := $auth.authorization -}}{{- $authc
:= $auth.authentication -}}
-{{- if $auth.enabled }}
-apiVersion: dubbo.io/v1alpha1
-kind: AuthenticationPolicy
-metadata:
- name: admin-authentication
- namespace: {{ template "admin.namespace" . }}
-spec:
- action: {{ $authc.action }}
- PortLevel:
- - port: {{ $authc.port }}
- selector:
- - namespaces: [{{ template "admin.namespace" . }}]
----
-apiVersion: dubbo.io/v1alpha1
-kind: AuthorizationPolicy
-metadata:
- name: admin-authorization
- namespace: {{ template "admin.namespace" . }}
-spec:
- action: {{ $authz.action }}
- matchType: {{ $authz.matchType }}
- rules:
- - from:
- namespaces: [{{ template "admin.namespace" . }}]
- samples: {{ $authz.samples }}
-{{- end }}
-
diff --git a/traffic/config.yaml b/traffic/config.yaml
deleted file mode 100644
index 70c59226..00000000
--- a/traffic/config.yaml
+++ /dev/null
@@ -1,49 +0,0 @@
-{{- $traffic := .Values.traffic -}}
-{{- $tr := $traffic.tagRoute -}}
-{{- $dc := $traffic.dynamicConfig -}}
-{{- $cr := $traffic.conditionRoute -}}
-apiVersion: dubbo.io/v1alpha1
-kind: ConditionRoute
-metadata:
- name: dubbo-conditionroute
- namespace: {{ template "admin.namespace" . }}
-spec:
- enabled: {{ $cr.enabled }}
- force: {{ $cr.force }}
- scope: {{ $cr.scope }}
- runtime: {{ $cr.runtime }}
- priority: {{ $cr.priority }}
- key: {{ $cr.key }}
- configVersion: {{ $cr.configVersion }}
- conditions:
- - {{ $cr.conditions }}
----
-apiVersion: dubbo.io/v1alpha1
-kind: DynamicConfig
-metadata:
- name: dubbo-dynamicconfig
- namespace: {{ template "admin.namespace" . }}
-spec:
- configVersion: {{ $dc.configVersion }}
- scope: {{ $dc.scope }}
- key: {{ $dc.key }}
- configs:
- - side: {{ $dc.side }}
- match:
- application:
- oneof:
- - exact: {{ $dc.exact }}
----
-apiVersion: dubbo.io/v1alpha1
-kind: TagRoute
-metadata:
- name: dubbp-tagroute
- namespace: {{ template "admin.namespace" . }}
-spec:
- configVersion: {{ $tr.configVersion }}
- force: {{ $tr.force }}
- enabled: {{ $tr.enabled }}
- priority: {{ $tr.priority }}
- key: {{ $tr.key }}
- tags:
- - name: {{ $tr.name }}
diff --git a/traffic/rbac.yaml b/traffic/rbac.yaml
deleted file mode 100644
index 11161551..00000000
--- a/traffic/rbac.yaml
+++ /dev/null
@@ -1,30 +0,0 @@
-apiVersion: v1
-kind: ServiceAccount
-metadata:
- name: dubbo-sa
- namespace: {{ template "admin.namespace" . }}
----
-apiVersion: rbac.authorization.k8s.io/v1
-kind: ClusterRole
-metadata:
- name: dubbo-clusterrole
-rules:
- - apiGroups:
- - ""
- resources:
- - namespaces
- verbs:
- - get
----
-apiVersion: rbac.authorization.k8s.io/v1
-kind: ClusterRoleBinding
-metadata:
- name: dubbo-clusterrolebinding
-roleRef:
- apiGroup: rbac.authorization.k8s.io
- kind: ClusterRole
- name: dubbo-clusterrole
-subjects:
- - kind: ServiceAccount
- name: dubbo-sa
- namespace: {{ template "admin.namespace" . }}
\ No newline at end of file