You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ro...@apache.org on 2021/08/23 11:10:23 UTC
[cloudstack-documentation] branch 4.15 updated (17a6ff4 -> e7588b7)
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a change to branch 4.15
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git.
from 17a6ff4 ui - Multiple server management documentation (#232)
new c14cc8e Revert "ui - Multiple server management documentation (#232)"
new 599cfe7 Adding cloudstack-kubernetes-provider docs (#233)
new e7588b7 ui - Multiple server management documentation (#232)
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
source/_static/images/ckp-ip-fw.png | Bin 0 -> 49848 bytes
source/_static/images/ckp-ip-lb.png | Bin 0 -> 102116 bytes
source/_static/images/ckp-ip.png | Bin 0 -> 37608 bytes
source/plugins/cloudstack-kubernetes-provider.rst | 153 ++++++++++++++++++++++
source/plugins/index.rst | 1 +
5 files changed, 154 insertions(+)
create mode 100644 source/_static/images/ckp-ip-fw.png
create mode 100644 source/_static/images/ckp-ip-lb.png
create mode 100644 source/_static/images/ckp-ip.png
create mode 100644 source/plugins/cloudstack-kubernetes-provider.rst
[cloudstack-documentation] 02/03: Adding
cloudstack-kubernetes-provider docs (#233)
Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch 4.15
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
commit 599cfe74114b94aa0c5394452bd2a4dd650c7591
Author: davidjumani <dj...@gmail.com>
AuthorDate: Tue Aug 3 11:16:23 2021 +0530
Adding cloudstack-kubernetes-provider docs (#233)
(cherry picked from commit 2f021fd97c02028023e327361bc36105300a8e85)
Signed-off-by: Rohit Yadav <ro...@shapeblue.com>
---
source/_static/images/ckp-ip-fw.png | Bin 0 -> 49848 bytes
source/_static/images/ckp-ip-lb.png | Bin 0 -> 102116 bytes
source/_static/images/ckp-ip.png | Bin 0 -> 37608 bytes
source/plugins/cloudstack-kubernetes-provider.rst | 153 ++++++++++++++++++++++
source/plugins/index.rst | 1 +
5 files changed, 154 insertions(+)
diff --git a/source/_static/images/ckp-ip-fw.png b/source/_static/images/ckp-ip-fw.png
new file mode 100644
index 0000000..bad6c3c
Binary files /dev/null and b/source/_static/images/ckp-ip-fw.png differ
diff --git a/source/_static/images/ckp-ip-lb.png b/source/_static/images/ckp-ip-lb.png
new file mode 100644
index 0000000..87be0c2
Binary files /dev/null and b/source/_static/images/ckp-ip-lb.png differ
diff --git a/source/_static/images/ckp-ip.png b/source/_static/images/ckp-ip.png
new file mode 100644
index 0000000..e4075ec
Binary files /dev/null and b/source/_static/images/ckp-ip.png differ
diff --git a/source/plugins/cloudstack-kubernetes-provider.rst b/source/plugins/cloudstack-kubernetes-provider.rst
new file mode 100644
index 0000000..910979c
--- /dev/null
+++ b/source/plugins/cloudstack-kubernetes-provider.rst
@@ -0,0 +1,153 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information#
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+The CloudStack Kubernetes Provider
+==================================
+
+Introduction
+------------
+
+The CloudStack Kubernetes Provider facilitates Kubernetes deployments on Cloudstack.
+It allows Kubernetes to dynamically allocate IP addresses and the respective networking
+rules on CloudStack to ensure seamless TCP, UDP and TCP-Proxy LoadBalancer deployments
+on Kubernetes.
+
+It also automatically manages these rules modifying them based on the deployment as well
+as the size of the cluster.
+
+It was initially the Cloudstack provider in Kubernetes which was later extracted to allow
+for pluggable providers.
+
+The Prebuilt containers are available on `Docker Hub <https://hub.docker.com/r/apache/cloudstack-kubernetes-provider>`_.
+
+Deployment
+----------
+The CloudStack Kubernetes Provider is automatically deployed when a Kuberentes Cluster is
+created on CloudStack 4.16+
+
+In order to communicate with CloudStack, a separate service user **kubeadmin** is created
+in the same account as the cluster owner. The provider uses this user's API keys to get
+the details of the cluster as well as update the networking rules. It is imperative that
+this user is not altered or have its keys regenerated.
+
+The provider can also be manually deployed with instructions `here
+<https://github.com/apache/cloudstack-kubernetes-provider/blob/main/README.md>`_
+
+Further details as well as instructions on how to build and contribute to the project can be found `here
+<https://github.com/apache/cloudstack-kubernetes-provider/blob/main/README.md>`_
+
+Usage
+-----
+
+In the following example, a LoadBalancer Service is created to balance traffic between the nodes in
+a cluster. The DaemonSet creates pods and maps the ports on the pods to the same ports on the host.
+The LoadBalancer creates an externally-accessible IP address that sends traffic to the correct port
+on the cluster nodes.
+
+#. The following yaml creates a DaemonSet which brings up a pod on every node and maps port 80 and
+ 443 from the pod to the node. The LoadBalancer Service then creates a public IP to balance traffic
+ on port 80 and 443 between the nodes.
+
+ .. parsed-literal::
+ ---
+ apiVersion: v1
+ kind: Service
+ metadata:
+ name: traefik
+ annotations:
+ service.beta.kubernetes.io/cloudstack-load-balancer-proxy-protocol: enabled
+ spec:
+ type: LoadBalancer
+ ports:
+ - name: http
+ port: 80
+ targetPort: http
+ - name: https
+ port: 443
+ targetPort: https
+ ---
+ apiVersion: v1
+ kind: ConfigMap
+ metadata:
+ name: traefik-conf
+ data:
+ traefik.toml: |
+ defaultEntryPoints = ["http"]
+ [entryPoints]
+ [entryPoints.http]
+ address = ":80"
+ [entryPoints.http.proxyProtocol]
+ trustedIPs = ["127.0.0.1/32", "10.0.0.1/32"]
+ [entryPoints.https]
+ address = ":443"
+ [entryPoints.https.proxyProtocol]
+ trustedIPs = ["127.0.0.1/32", "10.0.0.1/32"]
+ ---
+ apiVersion: apps/v1
+ kind: DaemonSet
+ metadata:
+ name: traefik-ingress-controller
+ spec:
+ selector:
+ matchLabels:
+ name: traefik-ingress-controller
+ template:
+ metadata:
+ labels:
+ name: traefik-ingress-controller
+ spec:
+ hostNetwork: true
+ containers:
+ - args:
+ - --configfile=/config/traefik.toml
+ image: traefik:1.7.12
+ imagePullPolicy: Always
+ name: traefik-ingress
+ ports:
+ - containerPort: 80
+ hostPort: 80
+ name: http
+ protocol: TCP
+ - containerPort: 443
+ hostPort: 443
+ name: https
+ protocol: TCP
+ volumeMounts:
+ - mountPath: /config
+ name: config
+ volumes:
+ - configMap:
+ defaultMode: 420
+ name: traefik-conf
+ name: config
+
+ It can be deployed by running the command
+
+ .. parsed-literal::
+ kubectl apply -f https://raw.githubusercontent.com/apache/cloudstack-kubernetes-provider/main/traefik-ingress-controller.yml
+
+#. On successfully deploying the yaml file, a new Public IP Address in the same network
+ as the cluster will be created. It will automatically have the firewall and port forwarding
+ rules configured to distribute any traffic amongst the cluster worker nodes
+
+|ckp-ip.png|
+
+|ckp-ip-fw.png|
+
+|ckp-ip-lb.png|
+
+.. |ckp-ip.png| image:: /_static/images/ckp-ip.png
+.. |ckp-ip-fw.png| image:: /_static/images/ckp-ip-fw.png
+.. |ckp-ip-lb.png| image:: /_static/images/ckp-ip-lb.png
diff --git a/source/plugins/index.rst b/source/plugins/index.rst
index 783e4f4..7e7c562 100644
--- a/source/plugins/index.rst
+++ b/source/plugins/index.rst
@@ -37,4 +37,5 @@ This is the Apache CloudStack Plugins guide. This section gives information for
ipv6
quota
cloudstack-kubernetes-service
+ cloudstack-kubernetes-provider.rst
[cloudstack-documentation] 01/03: Revert "ui - Multiple server
management documentation (#232)"
Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch 4.15
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
commit c14cc8e8d4f0d22cab17587ef2296e2b57d61dc5
Author: Rohit Yadav <ro...@shapeblue.com>
AuthorDate: Mon Aug 23 16:37:59 2021 +0530
Revert "ui - Multiple server management documentation (#232)"
This reverts commit 17a6ff447b422f8b2128d48a61ad6f33ba20ca11.
---
.../images/ui-multiple-server-management.png | Bin 30709 -> 0 bytes
source/adminguide/ui.rst | 63 ---------------------
2 files changed, 63 deletions(-)
diff --git a/source/_static/images/ui-multiple-server-management.png b/source/_static/images/ui-multiple-server-management.png
deleted file mode 100644
index 32f9645..0000000
Binary files a/source/_static/images/ui-multiple-server-management.png and /dev/null differ
diff --git a/source/adminguide/ui.rst b/source/adminguide/ui.rst
index b9fa334..5f8594b 100644
--- a/source/adminguide/ui.rst
+++ b/source/adminguide/ui.rst
@@ -472,66 +472,6 @@ Useful documentations:
- `JavaScript ES6 Reference <https://www.tutorialspoint.com/es6/>`_
- `Introduction to ES6 <https://scrimba.com/g/gintrotoes6>`_
-Multiple Management Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-User can use file `/etc/cloudstack/management/config.json` to configure the settings which allow Cloudstack to support multiple servers.
-
-To Cloudstack support use multiple servers, the following details can be edited in config.json:
-
-============================= ================================================================
-Property Description
-============================= ================================================================
-multipleServer Configure to allow Cloudstack to support multiple servers.
-servers List of servers to which Cloudstack can connect.
-============================= ================================================================
-
-.. parsed-literal::
-
- {
- ...
- "servers" [
- {
- "name": "server-1",
- "apiHost": "/server-1",
- "apiBase": "/client/api",
- },
- {
- "name": "server-2",
- "apiHost": "",
- "apiBase": "/client/api",
- }
- ]
- ...
- "multipleServer": true
- }
-
-For the UI to work with different servers, it is necessary to configure the Nginx config proxy to allow connections to the respective servers without Cross-Origin (to be put into /etc/nginx/conf.d/default/conf or similar).
-
-.. parsed-literal::
-
- server {
- listen 80;
- server_name localhost;
- location / {
- # /src/ui/dist contains the built UI webpack
- root /src/ui/dist;
- index index.html;
- }
- # for apiHost of server-1 located in config.json
- location /server-1/client/ {
- rewrite ^/server-1/(.*)$ /$1 break;
- # server's actual URI
- proxy_pass https://server-1.your.domain;
- }
- # for apiHost of server-2 located in config.json
- location /client/ {
- # server's actual URI
- proxy_pass https://server-2.your.domain;
- }
- }
-
-|ui-multiple-server-management.png|
Known Limitations
~~~~~~~~~~~~~~~~~
@@ -548,6 +488,3 @@ The following features are no longer supported or available in the UI but are st
.. |ui-custom-plugin.png| image:: /_static/images/ui-custom-plugin.png
:alt: Custom plugin shown in UI with navigation
-
-.. |ui-multiple-server-management.png| image:: /_static/images/ui-multiple-server-management.png
- :alt: Custom plugin shown in UI with navigation
[cloudstack-documentation] 03/03: ui - Multiple server management
documentation (#232)
Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch 4.15
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
commit e7588b7767ca5f13986420d47d8c6ac24c6d5891
Author: Hoang Nguyen <ho...@unitech.vn>
AuthorDate: Wed Aug 11 18:22:56 2021 +0700
ui - Multiple server management documentation (#232)
* multiple server management documentation
* modify the server name in the Nginx example
(cherry picked from commit 17a6ff447b422f8b2128d48a61ad6f33ba20ca11)
Signed-off-by: Rohit Yadav <ro...@shapeblue.com>
---
.../images/ui-multiple-server-management.png | Bin 0 -> 30709 bytes
source/adminguide/ui.rst | 63 +++++++++++++++++++++
2 files changed, 63 insertions(+)
diff --git a/source/_static/images/ui-multiple-server-management.png b/source/_static/images/ui-multiple-server-management.png
new file mode 100644
index 0000000..32f9645
Binary files /dev/null and b/source/_static/images/ui-multiple-server-management.png differ
diff --git a/source/adminguide/ui.rst b/source/adminguide/ui.rst
index 5f8594b..b9fa334 100644
--- a/source/adminguide/ui.rst
+++ b/source/adminguide/ui.rst
@@ -472,6 +472,66 @@ Useful documentations:
- `JavaScript ES6 Reference <https://www.tutorialspoint.com/es6/>`_
- `Introduction to ES6 <https://scrimba.com/g/gintrotoes6>`_
+Multiple Management Support
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+User can use file `/etc/cloudstack/management/config.json` to configure the settings which allow Cloudstack to support multiple servers.
+
+To Cloudstack support use multiple servers, the following details can be edited in config.json:
+
+============================= ================================================================
+Property Description
+============================= ================================================================
+multipleServer Configure to allow Cloudstack to support multiple servers.
+servers List of servers to which Cloudstack can connect.
+============================= ================================================================
+
+.. parsed-literal::
+
+ {
+ ...
+ "servers" [
+ {
+ "name": "server-1",
+ "apiHost": "/server-1",
+ "apiBase": "/client/api",
+ },
+ {
+ "name": "server-2",
+ "apiHost": "",
+ "apiBase": "/client/api",
+ }
+ ]
+ ...
+ "multipleServer": true
+ }
+
+For the UI to work with different servers, it is necessary to configure the Nginx config proxy to allow connections to the respective servers without Cross-Origin (to be put into /etc/nginx/conf.d/default/conf or similar).
+
+.. parsed-literal::
+
+ server {
+ listen 80;
+ server_name localhost;
+ location / {
+ # /src/ui/dist contains the built UI webpack
+ root /src/ui/dist;
+ index index.html;
+ }
+ # for apiHost of server-1 located in config.json
+ location /server-1/client/ {
+ rewrite ^/server-1/(.*)$ /$1 break;
+ # server's actual URI
+ proxy_pass https://server-1.your.domain;
+ }
+ # for apiHost of server-2 located in config.json
+ location /client/ {
+ # server's actual URI
+ proxy_pass https://server-2.your.domain;
+ }
+ }
+
+|ui-multiple-server-management.png|
Known Limitations
~~~~~~~~~~~~~~~~~
@@ -488,3 +548,6 @@ The following features are no longer supported or available in the UI but are st
.. |ui-custom-plugin.png| image:: /_static/images/ui-custom-plugin.png
:alt: Custom plugin shown in UI with navigation
+
+.. |ui-multiple-server-management.png| image:: /_static/images/ui-multiple-server-management.png
+ :alt: Custom plugin shown in UI with navigation