From 69c934d85da622a95515716dd8f5e1f060120a31 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Wed, 13 May 2020 14:47:29 +0530 Subject: [PATCH 01/15] primate docs WIP Signed-off-by: Rohit Yadav --- source/index.rst | 4 ++++ source/primate/index.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 source/primate/index.rst diff --git a/source/index.rst b/source/index.rst index ba69e42843..8b38126433 100644 --- a/source/index.rst +++ b/source/index.rst @@ -42,6 +42,10 @@ Information can also be found at CloudStack's wiki https://cwiki.apache.org/conf plugins/index releasenotes/index +.. toctree:: + :caption: Primate Documentation: + primate/index + Primate on Github .. toctree:: :caption: Other Documentation: diff --git a/source/primate/index.rst b/source/primate/index.rst new file mode 100644 index 0000000000..f4e6b3921f --- /dev/null +++ b/source/primate/index.rst @@ -0,0 +1,40 @@ +.. 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. + + +Primate Guide +============= + +Overview +-------- + +What is Primate? +~~~~~~~~~~~~~~~~ + +Apache CloudStack Primate is a modern role-based progressive CloudStack UI based +on VueJS and Ant Design. + +Topics: + +RPM/DEB repo setup/install +Archive setup/install +Docker setup/install + + +Configure, links etc. + +Known issues and limitations + +Version changelog? From 9e70e5f21266b192496595bac9fb3c1def48588b Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Wed, 13 May 2020 14:48:22 +0530 Subject: [PATCH 02/15] fix newlin Signed-off-by: Rohit Yadav --- source/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/index.rst b/source/index.rst index 8b38126433..5cccb26dee 100644 --- a/source/index.rst +++ b/source/index.rst @@ -44,6 +44,7 @@ Information can also be found at CloudStack's wiki https://cwiki.apache.org/conf .. toctree:: :caption: Primate Documentation: + primate/index Primate on Github From db7d22d6569b7144b8bca7d29c99e8de3511265a Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Wed, 13 May 2020 14:52:23 +0530 Subject: [PATCH 03/15] fix build issue Signed-off-by: Rohit Yadav --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index 5cccb26dee..3d81055fac 100644 --- a/source/index.rst +++ b/source/index.rst @@ -46,7 +46,7 @@ Information can also be found at CloudStack's wiki https://cwiki.apache.org/conf :caption: Primate Documentation: primate/index - Primate on Github + Primate on Github .. toctree:: :caption: Other Documentation: From d4f899fb9be73e9dde3a6b0f1dc570f3572fd3af Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Wed, 13 May 2020 16:04:07 +0530 Subject: [PATCH 04/15] move to sub-section under install guide Signed-off-by: Rohit Yadav --- source/installguide/index.rst | 10 ++++++++++ source/{primate/index.rst => installguide/primate.rst} | 0 2 files changed, 10 insertions(+) rename source/{primate/index.rst => installguide/primate.rst} (100%) diff --git a/source/installguide/index.rst b/source/installguide/index.rst index 01d90121bf..63dc803395 100644 --- a/source/installguide/index.rst +++ b/source/installguide/index.rst @@ -47,6 +47,16 @@ General Installation management-server/index +.. _primate: + +Primate Installation +-------------------- +.. toctree:: + :maxdepth: 2 + + primate + + .. _configuration: Configuration diff --git a/source/primate/index.rst b/source/installguide/primate.rst similarity index 100% rename from source/primate/index.rst rename to source/installguide/primate.rst From 0eb0da1877e00a09e77a76b9d92e707db00410df Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 04:51:38 +0530 Subject: [PATCH 05/15] finish doc Signed-off-by: Rohit Yadav --- source/index.rst | 5 -- source/installguide/primate.rst | 132 +++++++++++++++++++++++++++++--- 2 files changed, 120 insertions(+), 17 deletions(-) diff --git a/source/index.rst b/source/index.rst index 3d81055fac..ba69e42843 100644 --- a/source/index.rst +++ b/source/index.rst @@ -42,11 +42,6 @@ Information can also be found at CloudStack's wiki https://cwiki.apache.org/conf plugins/index releasenotes/index -.. toctree:: - :caption: Primate Documentation: - - primate/index - Primate on Github .. toctree:: :caption: Other Documentation: diff --git a/source/installguide/primate.rst b/source/installguide/primate.rst index f4e6b3921f..32f51a72bc 100644 --- a/source/installguide/primate.rst +++ b/source/installguide/primate.rst @@ -17,24 +17,132 @@ Primate Guide ============= -Overview --------- - What is Primate? ~~~~~~~~~~~~~~~~ -Apache CloudStack Primate is a modern role-based progressive CloudStack UI based -on VueJS and Ant Design. +Apache CloudStack Primate is a modern role-based progressive UI based on VueJS +and Ant Design for Apache CloudStack. + +.. image:: https://raw.githubusercontent.com/apache/cloudstack-primate/master/docs/screenshot-dashboard.png + :width: 800px + :alt: alternate text + :align: left + +With Apache CloudStack 4.14, a technical preview of Primate is proposed that +users can evaluate. The technical preview release is not officially voted +release by the Apache CloudStack project but offers a snapshot build of Primate +for users for testing and evaluation. The official Primate GA is expected with +the next CloudStack release where the legacy UI will be depreciated, and the +legacy UI will be removed in eventual major releases. + +.. parsed-literal:: + + NOTE: Primate tech-preview is not suitable to run in production environments. + +`User participation in the community mailing lists +`_ is encouraged and users may +also log issues on Github https://github.com/apache/cloudstack-primate/issues + +Installation on CentOS +~~~~~~~~~~~~~~~~~~~~~~ + +Users running management server (4.13 or above) on CentOS can setup the +following Primate tech-preview repository: + +.. parsed-literal:: + + rpm --import http://packages.shapeblue.com/release.asc + cat << EOF > /etc/yum.repos.d/cloudstack-primate-tech-preview.repo + [cloudstack-primate-tech-preview] + name=cloudstack + baseurl=https://download.cloudstack.org/primate/testing/preview/centos/ + enabled=1 + gpgcheck=1 + gpgkey=https://download.cloudstack.org/primate/release.asc + EOF + +Next, install Primate: + +.. parsed-literal:: + + yum install cloudstack-primate + +Note: there is no need to restart management server post-installation, Primate +can be accessed on management-server-host:8080/client/primate in any modern +browser. + +Installation on Ubuntu +~~~~~~~~~~~~~~~~~~~~~~ + +Users running CloudStack management server (4.13 or above) on Ubuntu can setup the following Primate tech-preview repository: + +.. parsed-literal:: + + apt-key adv --keyserver keys.gnupg.net --recv-keys BDF0E176584DF93F + echo deb https://download.cloudstack.org/primate/testing/preview/debian / > /etc/apt/sources.list.d/cloudstack-primate-tech-preview.list + +Next, install Primate: + +.. parsed-literal:: + + apt-get update + apt-get install cloudstack-primate + +Note: there is no need to restart management server post-installation, Primate +can be accessed on management-server-host:8080/client/primate in any modern +browser. + +Using Archive +~~~~~~~~~~~~~ + +Primate archives are tarballs of single-page app builds. They can be simply +downloaded and extracted to the management server webapp directory or hosted +with a custom webserver. + +Users can download the builds from https://download.cloudstack.org/primate/testing/preview/archive/ + +Using Docker +~~~~~~~~~~~~ + +Users can use docker builds of the tech preview from https://hub.docker.com/r/apache/cloudstack-primate + +For example: + +.. parsed-literal:: + + docker pull apache/cloudstack-primate:tech-preview + docker run -ti --rm -p 8080:80 -v $(pwd)/nginx:/etc/nginx/conf.d:ro apache/cloudstack-primate:tech-preview -Topics: +Example nginx config: -RPM/DEB repo setup/install -Archive setup/install -Docker setup/install +.. parsed-literal:: + server { + listen 80; + server_name localhost; + location / { + root /usr/share/nginx/html; + index index.html; + } + location /client/ { + # http://127.0.0.1:8080 should be replaced your CloudStack management + # Server's actual URI + proxy_pass http://127.0.0.1:8080; + } + } -Configure, links etc. +Known Issues and Limitations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Known issues and limitations +- Support for network service providers +- Support for S3 based secondary storage +- Full support for all Quota plugin views +- Group actions for events, alerts and instances +- Metrics view cell-colouring +- Authorisation management for SAML users +- Filter by feature for searching +- Guest network LB support for SSL certificate +- Not all translations are not fully migrated from legacy UI to Primate. +- Feature and enhancements added in 4.14 except CloudStack Kubernetes Service and Backup and Recovery -Version changelog? +Please also refer to open issues on https://github.com/apache/cloudstack-primate/issues From 74892d66a097d17907bc538f5a7cd9667357b1b5 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 14:15:17 +0530 Subject: [PATCH 06/15] Update primate.rst --- source/installguide/primate.rst | 42 ++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/source/installguide/primate.rst b/source/installguide/primate.rst index 32f51a72bc..4415d10f1e 100644 --- a/source/installguide/primate.rst +++ b/source/installguide/primate.rst @@ -20,7 +20,7 @@ Primate Guide What is Primate? ~~~~~~~~~~~~~~~~ -Apache CloudStack Primate is a modern role-based progressive UI based on VueJS +Apache CloudStack Primate is a modern role-based progressive UI based on Vue.js and Ant Design for Apache CloudStack. .. image:: https://raw.githubusercontent.com/apache/cloudstack-primate/master/docs/screenshot-dashboard.png @@ -29,20 +29,34 @@ and Ant Design for Apache CloudStack. :align: left With Apache CloudStack 4.14, a technical preview of Primate is proposed that -users can evaluate. The technical preview release is not officially voted +users can evaluate. The technical preview release is not an officially voted release by the Apache CloudStack project but offers a snapshot build of Primate for users for testing and evaluation. The official Primate GA is expected with -the next CloudStack release where the legacy UI will be depreciated, and the -legacy UI will be removed in eventual major releases. +the next CloudStack release where the legacy UI will be deprecated, and the +legacy UI will be removed in an eventual major CloudStack release. .. parsed-literal:: NOTE: Primate tech-preview is not suitable to run in production environments. `User participation in the community mailing lists -`_ is encouraged and users may +`_ is encouraged. Users may also log issues on Github https://github.com/apache/cloudstack-primate/issues +Requirements +~~~~~~~~~~~~ + +Primate uses API auto-discovery to discover APIs allowed for a logged-in user +and creates navigation and views based on that. + +- Apache CloudStack 4.13.1.0 or later +- API auto-discovery (listApis enabled) +- All modern browsers that are `ES5-compliant `_ + +While in theory Primate can work with any older version of CloudStack however +several Primate list views require API pagination support some of which are +available starting Apache CloudStack 4.13.1.0. + Installation on CentOS ~~~~~~~~~~~~~~~~~~~~~~ @@ -51,7 +65,7 @@ following Primate tech-preview repository: .. parsed-literal:: - rpm --import http://packages.shapeblue.com/release.asc + rpm --import https://download.cloudstack.org/primate/release.asc cat << EOF > /etc/yum.repos.d/cloudstack-primate-tech-preview.repo [cloudstack-primate-tech-preview] name=cloudstack @@ -67,9 +81,9 @@ Next, install Primate: yum install cloudstack-primate -Note: there is no need to restart management server post-installation, Primate -can be accessed on management-server-host:8080/client/primate in any modern -browser. +Note: there is no need to restart management server post-installation, and +after installation the UI can be accessed on +management-server-host:8080/client/primate using any modern browser. Installation on Ubuntu ~~~~~~~~~~~~~~~~~~~~~~ @@ -88,9 +102,9 @@ Next, install Primate: apt-get update apt-get install cloudstack-primate -Note: there is no need to restart management server post-installation, Primate -can be accessed on management-server-host:8080/client/primate in any modern -browser. +Note: there is no need to restart management server post-installation, and +after installation the UI can be accessed on +management-server-host:8080/client/primate using any modern browser. Using Archive ~~~~~~~~~~~~~ @@ -131,8 +145,8 @@ Example nginx config: } } -Known Issues and Limitations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Known Issues and Missing Features +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Support for network service providers - Support for S3 based secondary storage From 50cf679e88dcd52fefbd10210c9b8626b0c85108 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 14:25:20 +0530 Subject: [PATCH 07/15] Update primate.rst --- source/installguide/primate.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/installguide/primate.rst b/source/installguide/primate.rst index 4415d10f1e..8466058575 100644 --- a/source/installguide/primate.rst +++ b/source/installguide/primate.rst @@ -43,6 +43,8 @@ legacy UI will be removed in an eventual major CloudStack release. `_ is encouraged. Users may also log issues on Github https://github.com/apache/cloudstack-primate/issues +:ref:`primate-install-guide` + Requirements ~~~~~~~~~~~~ From 42af36259fb7da3636ce07b8ba9a8d9fae63c873 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 14:30:47 +0530 Subject: [PATCH 08/15] Update about.rst --- source/releasenotes/about.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst index 3318bac485..0da6916be8 100644 --- a/source/releasenotes/about.rst +++ b/source/releasenotes/about.rst @@ -45,3 +45,11 @@ The full list of new features can be found in the project release notes at http: Apache CloudStack powers numerous elastic Cloud computing services, including solutions that have ranked as Gartner Magic Quadrant leaders. Highlighted in the Forrester Q4 2017 Enterprise Open Source Cloud Adoption report, Apache CloudStack "sits beneath hundreds of service provider clouds", including Fortune 5 multinational corporations. A list of known Apache CloudStack users are available at http://cloudstack.apache.org/users.html +UI Deprecation Notice +--------------------- + +A modern UI for Apache CloudStack - Primate has been proposed, a technical preview of which +can be evaluated with this release. Please see the Primate install guide :ref:`_primate-install-guide`. + +The current legacy UI will be deprecated in the next CloudStack major release which will ship +Primate GA and in later CloudStack major release the legacy UI will be removed. From 4a72de3a4faca3f6f255b5d9f057cd1f0c21cd96 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 14:31:15 +0530 Subject: [PATCH 09/15] Update primate.rst --- source/installguide/primate.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/installguide/primate.rst b/source/installguide/primate.rst index 8466058575..df97ca55cd 100644 --- a/source/installguide/primate.rst +++ b/source/installguide/primate.rst @@ -13,6 +13,7 @@ specific language governing permissions and limitations under the License. +:ref:`primate-install-guide` Primate Guide ============= @@ -43,8 +44,6 @@ legacy UI will be removed in an eventual major CloudStack release. `_ is encouraged. Users may also log issues on Github https://github.com/apache/cloudstack-primate/issues -:ref:`primate-install-guide` - Requirements ~~~~~~~~~~~~ From 1f9d6135cfc4b0691bf5c6b61ff5349b69f69ad4 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 14:40:20 +0530 Subject: [PATCH 10/15] Update about.rst --- source/releasenotes/about.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst index 0da6916be8..110038a6a4 100644 --- a/source/releasenotes/about.rst +++ b/source/releasenotes/about.rst @@ -18,10 +18,10 @@ What's New in |release| ======================= -What's New in 4.13.1.0 +What's New in |release| ---------------------- -The new 4.13.1.0 version is a 4.13 maintenance release containing almost 100 +The new |release| version is a 4.13 maintenance release containing almost 100 fixes and improvements on the 4.13.0.0 release. @@ -49,7 +49,7 @@ UI Deprecation Notice --------------------- A modern UI for Apache CloudStack - Primate has been proposed, a technical preview of which -can be evaluated with this release. Please see the Primate install guide :ref:`_primate-install-guide`. +can be evaluated with this release. Please see the `Primate install guide `. The current legacy UI will be deprecated in the next CloudStack major release which will ship Primate GA and in later CloudStack major release the legacy UI will be removed. From 89ccfe805ac8a71c6bb93cd9173fa546d37a0505 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 14:44:42 +0530 Subject: [PATCH 11/15] Update about.rst --- source/releasenotes/about.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst index 110038a6a4..49498c9207 100644 --- a/source/releasenotes/about.rst +++ b/source/releasenotes/about.rst @@ -49,7 +49,7 @@ UI Deprecation Notice --------------------- A modern UI for Apache CloudStack - Primate has been proposed, a technical preview of which -can be evaluated with this release. Please see the `Primate install guide `. +can be evaluated with this release. Please see the `Primate install guide `_. The current legacy UI will be deprecated in the next CloudStack major release which will ship Primate GA and in later CloudStack major release the legacy UI will be removed. From d25d920e981d0e870739e509fe291e4d31f55347 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Sat, 23 May 2020 14:48:18 +0530 Subject: [PATCH 12/15] Update about.rst --- source/releasenotes/about.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst index 49498c9207..651ce08375 100644 --- a/source/releasenotes/about.rst +++ b/source/releasenotes/about.rst @@ -49,7 +49,7 @@ UI Deprecation Notice --------------------- A modern UI for Apache CloudStack - Primate has been proposed, a technical preview of which -can be evaluated with this release. Please see the `Primate install guide `_. +can be evaluated with this release. Please see the `Primate install guide <../installguide/primate.html>`_. The current legacy UI will be deprecated in the next CloudStack major release which will ship Primate GA and in later CloudStack major release the legacy UI will be removed. From a75a397781b5ae2be6660c1ee052187eb14fce77 Mon Sep 17 00:00:00 2001 From: Andrija Panic <45762285+andrijapanicsb@users.noreply.github.com> Date: Sat, 23 May 2020 16:31:32 +0200 Subject: [PATCH 13/15] Update primate.rst --- source/installguide/primate.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/installguide/primate.rst b/source/installguide/primate.rst index df97ca55cd..bb01464bf9 100644 --- a/source/installguide/primate.rst +++ b/source/installguide/primate.rst @@ -54,8 +54,8 @@ and creates navigation and views based on that. - API auto-discovery (listApis enabled) - All modern browsers that are `ES5-compliant `_ -While in theory Primate can work with any older version of CloudStack however -several Primate list views require API pagination support some of which are +In theory Primate can work with any older version of CloudStack. +However, several Primate list views require API pagination support, some of which are available starting Apache CloudStack 4.13.1.0. Installation on CentOS @@ -157,7 +157,7 @@ Known Issues and Missing Features - Authorisation management for SAML users - Filter by feature for searching - Guest network LB support for SSL certificate -- Not all translations are not fully migrated from legacy UI to Primate. +- Not all translations are fully migrated from legacy UI to Primate. - Feature and enhancements added in 4.14 except CloudStack Kubernetes Service and Backup and Recovery Please also refer to open issues on https://github.com/apache/cloudstack-primate/issues From 2ce6c0d5db0f91bad43833a080d8a3f5373b192e Mon Sep 17 00:00:00 2001 From: Andrija Panic <45762285+andrijapanicsb@users.noreply.github.com> Date: Sat, 23 May 2020 16:32:37 +0200 Subject: [PATCH 14/15] Update about.rst --- source/releasenotes/about.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst index 651ce08375..a5aa49e08a 100644 --- a/source/releasenotes/about.rst +++ b/source/releasenotes/about.rst @@ -45,8 +45,8 @@ The full list of new features can be found in the project release notes at http: Apache CloudStack powers numerous elastic Cloud computing services, including solutions that have ranked as Gartner Magic Quadrant leaders. Highlighted in the Forrester Q4 2017 Enterprise Open Source Cloud Adoption report, Apache CloudStack "sits beneath hundreds of service provider clouds", including Fortune 5 multinational corporations. A list of known Apache CloudStack users are available at http://cloudstack.apache.org/users.html -UI Deprecation Notice ---------------------- +New modern UI / old UI Deprecation Notice +------------------------------------------ A modern UI for Apache CloudStack - Primate has been proposed, a technical preview of which can be evaluated with this release. Please see the `Primate install guide <../installguide/primate.html>`_. From d13e39ef7e2cb028dc0e7285358629f6f8c07497 Mon Sep 17 00:00:00 2001 From: Andrija Panic <45762285+andrijapanicsb@users.noreply.github.com> Date: Mon, 25 May 2020 14:15:00 +0200 Subject: [PATCH 15/15] Update about.rst --- source/releasenotes/about.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst index a5aa49e08a..ff81f562b2 100644 --- a/source/releasenotes/about.rst +++ b/source/releasenotes/about.rst @@ -45,7 +45,7 @@ The full list of new features can be found in the project release notes at http: Apache CloudStack powers numerous elastic Cloud computing services, including solutions that have ranked as Gartner Magic Quadrant leaders. Highlighted in the Forrester Q4 2017 Enterprise Open Source Cloud Adoption report, Apache CloudStack "sits beneath hundreds of service provider clouds", including Fortune 5 multinational corporations. A list of known Apache CloudStack users are available at http://cloudstack.apache.org/users.html -New modern UI / old UI Deprecation Notice +New Modern UI / old UI Deprecation Notice ------------------------------------------ A modern UI for Apache CloudStack - Primate has been proposed, a technical preview of which