Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added the Super Script Page in the FLINT Reporting Tool docs. #55

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Added the Super Script Page in the FLINT Reporting Tool docs. #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c29f3f5
Update the Scripts
AayushSaini101 Feb 16, 2022
20fa0f7
Updated
AayushSaini101 Feb 23, 2022
248c422
Changed
AayushSaini101 Feb 23, 2022
46ddf15
Delete 162.e2033aee64a56494.js
AayushSaini101 Mar 10, 2022
fd818d1
Delete 175.5a051b92c21c2580.js
AayushSaini101 Mar 10, 2022
35ed792
Merge branch 'moja-global:master' into master
AayushSaini101 Mar 10, 2022
62c68ff
remove the dist folder
HarshCasper Mar 15, 2022
c19253f
Merge branch 'moja-global:master' into master
AayushSaini101 Mar 16, 2022
66f33e5
Added SuperScripts in docs
AayushSaini101 Mar 17, 2022
b5ee105
SuperScript page
AayushSaini101 Mar 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
411 changes: 100 additions & 311 deletions code/client/package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 4 additions & 5 deletions docs/EnvironmentGuide/java-environment-setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Follow the instructions below to install the JDK:

.. code:: sh

cd ~/scripts/environment/jdk
FLINT.Reporting/code/scripts/setup/environment/jdk

2. Invoke the JDK installation script:

.. code:: sh

./install_jdk.sh
bash install.sh

Install Apache Maven
--------------------
Expand All @@ -27,10 +27,9 @@ Follow the instructions below to install Maven:

.. code:: sh

cd ~/scripts/environment/maven

FLINT.Reporting/code/scripts/setup/environment/jdk
2. Invoke the maven installation script:

.. code:: sh

./install_maven.sh
bash install.sh
53 changes: 18 additions & 35 deletions docs/EnvironmentGuide/kubernetes-environment-setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Follow the instructions below to install Kubernetes:

.. code:: sh

cd ~/scripts/environment/kubernetes
FLINT.Reporting/code/scripts/setup/environment/kubernetes

2. Invoke the Kubernetes installation script:

.. code:: sh

./install_kubernetes.sh
bash install.sh

Create Kubernetes Cluster
-------------------------
Expand All @@ -27,13 +27,13 @@ Follow the instructions below to create a Kubernetes cluster:

.. code:: sh

cd ~/scripts/environment/kubernetes/cluster
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster

2. Invoke the kubernetes-cluster initialization script:

.. code:: sh

./initialize_kubernetes_cluster.sh
bash initialize.sh

Add Docker Registry Secret to the Cluster
-----------------------------------------
Expand All @@ -46,13 +46,13 @@ cluster:

.. code:: sh

cd ~/scripts/environment/kubernetes/secrets
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster/secrets

2. Invoke the add private docker registry secret script:

.. code:: sh

./add_private_docker_registry_secret.sh
bash add_private_docker_registry_secret.sh

Add Weavenet to the Cluster
---------------------------
Expand All @@ -63,13 +63,13 @@ Follow the instructions below to add Weavenet to the cluster:

.. code:: sh

cd ~/scripts/environment/weavenet
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster/addons/weavenet

2. Invoke the meta installation script:

.. code:: sh

./install_weavenet.sh
bash install.sh

Install Helm
------------
Expand All @@ -80,13 +80,13 @@ Follow the instructions below to install Helm:

.. code:: sh

cd ~/scripts/environment/helm
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster/addons/helm

2. Invoke the helm installation script:

.. code:: sh

./install_helm.sh
bash install.sh

Add Traefik to the Cluster
--------------------------
Expand All @@ -97,13 +97,13 @@ Follow the instructions below to add Traefik to the cluster:

.. code:: sh

cd ~/scripts/environment/traefik
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster/addons/traefik

2. Invoke the traefik installation script:

.. code:: sh

./install_traefik.sh
bash install.sh

Add Storage Volumes to the Cluster
----------------------------------
Expand All @@ -116,7 +116,7 @@ cluster:

.. code:: sh

cd ~/scripts/environment/kubernetes/storage
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster/addons/storage

2. Reload the environmental variables:

Expand All @@ -128,7 +128,7 @@ cluster:

.. code:: sh

./install_storage_volumes.sh
bash install.sh

Add PostgreSQL to the Cluster
-----------------------------
Expand All @@ -139,30 +139,13 @@ Follow the instructions below to add PostgreSQL to the cluster:

.. code:: sh

cd ~/scripts/environment/postgres
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster/addons/postgresql

2. Invoke the Postgres installation script:

.. code:: sh

./install_postgres.sh

Add Cassandra to the Cluster
----------------------------

Follow the instructions below to add Cassandra to the cluster:

1. Navigate to the Cassandra setup scripts directory on the server:

.. code:: sh

cd ~/scripts/environment/cassandra

2. Invoke the Cassandra installation script:

.. code:: sh

./install_cassandra.sh
bash install.sh

Add RabbitMQ to the Cluster
---------------------------
Expand All @@ -173,10 +156,10 @@ Follow the instructions below to add RabbitMQ to the cluster:

.. code:: sh

cd ~/scripts/environment/rabbitmq
FLINT.Reporting/code/scripts/setup/environment/kubernetes/cluster/addons/rabbitmq

2. Invoke the rabbitmq installation script:

.. code:: sh

./install_rabbitmq.sh
bash install.sh
4 changes: 2 additions & 2 deletions docs/EnvironmentGuide/meta-environment-setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Follow the instructions below to install Meta:

.. code:: sh

cd ~/scripts/environment/meta
FLINT.Reporting/code/scripts/setup/environment/meta

2. Invoke the meta installation script:

.. code:: sh

./install_meta.sh
bash install.sh
12 changes: 6 additions & 6 deletions docs/EnvironmentGuide/nodejs-environment-setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Follow the instructions below to install the NodeJS:

.. code:: sh

cd ~/scripts/environment/nodejs
FLINT.Reporting/code/scripts/setup/environment/nodejs

2. Invoke the NodeJS installation script:

.. code:: sh

./install_nodejs.sh
bash install.sh

Install NPM
-----------
Expand All @@ -27,13 +27,13 @@ Follow the instructions below to install NPM:

.. code:: sh

cd ~/scripts/environment/npm
FLINT.Reporting/code/scripts/setup/environment/npm

2. Invoke the npm installation script:

.. code:: sh

./install_npm.sh
bash install.sh

Install Angular
---------------
Expand All @@ -44,10 +44,10 @@ Follow the instructions below to install Angular:

.. code:: sh

cd ~/scripts/environment/angular
FLINT.Reporting/code/scripts/setup/environment/angular

2. Invoke the Angular installation script:

.. code:: sh

./install_angular.sh
bash install.sh
4 changes: 2 additions & 2 deletions docs/EnvironmentGuide/security-environment-setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ a public CA, proceed as follows:
1. Navigate to the openssl scripts directory on the server:
::

cd ~/scripts/environment/openssl
FLINT.Reporting/code/scripts/setup/environment/openssl

2. Invoke the generate keys and certificates script:
::

./generate_keys_and_certificates.sh
bash generate.sh

3. Follow the wizards instructions.

Expand Down
59 changes: 59 additions & 0 deletions docs/SuperScripts/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Super Scripts
=================
This docmentation provides a easy way to setup the FLINT Reporting tool.

Steps to setting up the FLINT Reporting Tool
-------------------------------------------
1. In order to set up the first fork the project from the repositery.

2. Clone the repositery in your local machine.

.. code:: sh

git clone https://github.com/<YOUR_GITHUB_USERNAME>/FLINT.Reporting.git

3. Go into the directory containing the superscript.

.. code:: sh

cd code/scripts/setup/environment/superscript

4. Run the superscript to install all packages/dependencies for setting up the system's environment.

.. code:: sh

bash superscript.sh

Steps to setting up the Environment for the Reporting Tool over the server.

5. Enter the server domain:
.. code:: sh

reporter.miles.co.ke

6. Enter the domain name for traefik:
.. code:: sh

traefik.miles.co.ke

7. Enter the domain name for rabbitMQ.

.. code:: sh

rabbitMQ.miles.co.ke

8. Enter the server's default IP.

.. code:: sh

IP Address of the server. (For eg: 172.31.25.183)
9. Enter the server's local IP.
.. code:: sh

IP Address of the server. (For eg: 172.31.25.183)
10. Enter the IP allocation range.
.. code:: sh

IP Allocation range (For eg: 10.32.0.0/12)