intuit · kevin-mcgoldrick · Jul 22, 2022 · Jul 19, 2022
diff --git a/mkdocs/.gitignore b/mkdocs/.gitignore
@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
diff --git a/mkdocs/README.md b/mkdocs/README.md
@@ -0,0 +1,28 @@
+# tank-docs
+This is the new manifestation of Tank's documentation, leveraging the very powerful docs solution "Material fo MkDocs"(mkdocs-material)
+
+# What does this new doc site fulfill?
+
+This new doc site, being built on mkdocs-material,
+
+* Ships with a very user-friendly documentation ecosystem. 
+* Ships with a  powerful Search feature to easily search any content within the docs.
+* Provides a streamlined Navigation experience, being organised for the best understanding experience
+* The documentation itself has been reviewed and revamped at places, for better understandability
+* There are code blocks and content tabs, which keep the reader focused with its concise layout.
+* Last but not the least, this doc site is version controlled on Git, which is a plus.
+
+# Installation and ops
+## Running on local 
+Get into the `mkdocs` folder. 
+Install dependencies from Requirements file:  `pip install -r requirements.txt`
+Run locally using comamnd: `python3 -m mkdocs serve`
+
+## Publishing the docs site
+Publish docs site using command: `mkdocs gh-deploy --force`
+
+## References
+Detailed documentation for mkdocs-material is available under https://squidfunk.github.io/mkdocs-material/
+
+# Credits
+Made with ❤️ using `squidfunk/mkdocs-material`
diff --git a/mkdocs/docs/.pages b/mkdocs/docs/.pages
@@ -0,0 +1,7 @@
+nav:
+    - index.md
+    - Key Concepts: key-concepts
+    - roles.md
+    - administration.md
+    - supplemental-tools.md    
+    - Set-up and Installation: installation-guide
diff --git a/mkdocs/docs/administration.md b/mkdocs/docs/administration.md
@@ -0,0 +1,31 @@
+# Administration
+If you have administrator rights, you will see the `Admin` link at the top of the page. The `Admin` section allows you to view log files, administer users, and set log levels.
+
+## User Management
+
+As discussed in the `Users and Groups` section, Tank users have specific roles that dictate which actions they're allowed to perform on which entities. Users may have multiple roles, and any user may edit any entity which they own.
+
+<figure markdown>
+  ![User Management](../assets/admin/admin_2.png){ width="600" }
+  <figcaption>User Management</figcaption>
+</figure>
+
+### Assigning Roles
+
+To assign a role to a user, navigate to the `Admin` section and follow the link to `Administer Users`. Once you've selected a user to administer, change their roles by moving the desired options from the `Available Groups` column to the `Member Groups` column. When finished, click the `Save` button.
+
+<figure markdown>
+  ![Assigning Roles](../assets/admin/admin_3.png){ width="600" }
+  <figcaption>Assigning Roles</figcaption>
+</figure>
+
+
+# Log Viewer
+The log viewer alows you to see the server logs. It works like the tail Linux command.  
+
+<figure markdown>
+  ![Log Viewer](../assets/admin/admin_4.png){ width="600" }
+  <figcaption>Log Viewer</figcaption>
+</figure>
+
+
diff --git a/mkdocs/docs/assets/TankLogo.svg b/mkdocs/docs/assets/TankLogo.svg
diff --git a/mkdocs/docs/assets/admin/admin_1.png b/mkdocs/docs/assets/admin/admin_1.png
diff --git a/mkdocs/docs/assets/admin/admin_2.png b/mkdocs/docs/assets/admin/admin_2.png
diff --git a/mkdocs/docs/assets/admin/admin_3.png b/mkdocs/docs/assets/admin/admin_3.png
diff --git a/mkdocs/docs/assets/admin/admin_4.png b/mkdocs/docs/assets/admin/admin_4.png
diff --git a/mkdocs/docs/assets/datafiles/datafiles_1.png b/mkdocs/docs/assets/datafiles/datafiles_1.png
diff --git a/mkdocs/docs/assets/datafiles/datafiles_2.png b/mkdocs/docs/assets/datafiles/datafiles_2.png
diff --git a/mkdocs/docs/assets/datafiles/datafiles_3.png b/mkdocs/docs/assets/datafiles/datafiles_3.png
diff --git a/mkdocs/docs/assets/datafiles/datafiles_4.png b/mkdocs/docs/assets/datafiles/datafiles_4.png
diff --git a/mkdocs/docs/assets/datafiles/datafiles_5.png b/mkdocs/docs/assets/datafiles/datafiles_5.png
diff --git a/mkdocs/docs/assets/filters/filters_1.png b/mkdocs/docs/assets/filters/filters_1.png
diff --git a/mkdocs/docs/assets/filters/filters_2.png b/mkdocs/docs/assets/filters/filters_2.png
diff --git a/mkdocs/docs/assets/filters/filters_3.png b/mkdocs/docs/assets/filters/filters_3.png
diff --git a/mkdocs/docs/assets/filters/filters_4.png b/mkdocs/docs/assets/filters/filters_4.png
diff --git a/mkdocs/docs/assets/filters/filters_5.png b/mkdocs/docs/assets/filters/filters_5.png
diff --git a/mkdocs/docs/assets/filters/filters_6.png b/mkdocs/docs/assets/filters/filters_6.png
diff --git a/mkdocs/docs/assets/intuit_tank_projects_1.png b/mkdocs/docs/assets/intuit_tank_projects_1.png
diff --git a/mkdocs/docs/assets/projects/projects_1.png b/mkdocs/docs/assets/projects/projects_1.png
diff --git a/mkdocs/docs/assets/projects/projects_10.png b/mkdocs/docs/assets/projects/projects_10.png
diff --git a/mkdocs/docs/assets/projects/projects_11.png b/mkdocs/docs/assets/projects/projects_11.png
diff --git a/mkdocs/docs/assets/projects/projects_12.png b/mkdocs/docs/assets/projects/projects_12.png
diff --git a/mkdocs/docs/assets/projects/projects_13.png b/mkdocs/docs/assets/projects/projects_13.png
diff --git a/mkdocs/docs/assets/projects/projects_14.png b/mkdocs/docs/assets/projects/projects_14.png
diff --git a/mkdocs/docs/assets/projects/projects_2.png b/mkdocs/docs/assets/projects/projects_2.png
diff --git a/mkdocs/docs/assets/projects/projects_3.png b/mkdocs/docs/assets/projects/projects_3.png
diff --git a/mkdocs/docs/assets/projects/projects_4.png b/mkdocs/docs/assets/projects/projects_4.png
diff --git a/mkdocs/docs/assets/projects/projects_5.png b/mkdocs/docs/assets/projects/projects_5.png
diff --git a/mkdocs/docs/assets/projects/projects_6.png b/mkdocs/docs/assets/projects/projects_6.png
diff --git a/mkdocs/docs/assets/projects/projects_7.png b/mkdocs/docs/assets/projects/projects_7.png
diff --git a/mkdocs/docs/assets/projects/projects_8.png b/mkdocs/docs/assets/projects/projects_8.png
diff --git a/mkdocs/docs/assets/projects/projects_9.png b/mkdocs/docs/assets/projects/projects_9.png
diff --git a/mkdocs/docs/assets/scripts/scripts_1.0.png b/mkdocs/docs/assets/scripts/scripts_1.0.png
diff --git a/mkdocs/docs/assets/scripts/scripts_1.png b/mkdocs/docs/assets/scripts/scripts_1.png
diff --git a/mkdocs/docs/assets/scripts/scripts_2.png b/mkdocs/docs/assets/scripts/scripts_2.png
diff --git a/mkdocs/docs/assets/scripts/scripts_3.png b/mkdocs/docs/assets/scripts/scripts_3.png
diff --git a/mkdocs/docs/assets/scripts/scripts_4.png b/mkdocs/docs/assets/scripts/scripts_4.png
diff --git a/mkdocs/docs/assets/scripts/scripts_5.png b/mkdocs/docs/assets/scripts/scripts_5.png
diff --git a/mkdocs/docs/assets/scripts/scripts_6.png b/mkdocs/docs/assets/scripts/scripts_6.png
diff --git a/mkdocs/docs/assets/scripts/scripts_7.png b/mkdocs/docs/assets/scripts/scripts_7.png
diff --git a/mkdocs/docs/assets/scripts/scripts_8.png b/mkdocs/docs/assets/scripts/scripts_8.png
diff --git a/mkdocs/docs/assets/tools/tools_1.png b/mkdocs/docs/assets/tools/tools_1.png
diff --git a/mkdocs/docs/assets/tools/tools_2.png b/mkdocs/docs/assets/tools/tools_2.png
diff --git a/mkdocs/docs/gatlings-vs-tank.md b/mkdocs/docs/gatlings-vs-tank.md
@@ -0,0 +1,37 @@
+# Idealogy: Gatling vs Tank
+<div class="grid cards" markdown>
+
+-   :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__
+
+    ---
+
+    Install [`mkdocs-material`](#) with [`pip`](#) and get up
+    and running in minutes
+
+    [:octicons-arrow-right-24: Getting started](#)
+
+-   :fontawesome-brands-markdown:{ .lg .middle } __It's just Markdown__
+
+    ---
+
+    Focus on your content and generate a responsive and searchable static site
+
+    [:octicons-arrow-right-24: Reference](#)
+
+-   :material-format-font:{ .lg .middle } __Made to measure__
+
+    ---
+
+    Change the colors, fonts, language, icons, logo and more with a few lines
+
+    [:octicons-arrow-right-24: Customization](#)
+
+-   :material-scale-balance:{ .lg .middle } __Open Source, MIT__
+
+    ---
+
+    Material for MkDocs is licensed under MIT and available on [GitHub]
+
+    [:octicons-arrow-right-24: License](#)
+
+</div>
diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md
@@ -0,0 +1,21 @@
+# Welcome to Intuit Tank
+
+Intuit Tank(called `The Tank` for brevity) is a open-source load test platform from Intuit that runs in a cloud environment. It currently supports Amazon web interfaces and utilizes services from `EC2`, `S3` and `DynamoDB`.
+
+## Constituents
+Tank has two main components: A Controller Interface and (one or many) agent(s).
+
+### Controller
+The Controller is the central hub/Control Plane for Tank.It supports the GUI for managing tests and for orchestrating.   
+It utilizes Apache Tomcat for a web container and ActiveMQ as a message queue for communication.   
+It exposes a `REST`ful interface for invoking services. It stores data in a `SQL` database, and uses a `AWS S3` bucket as a shared filesystem.   
+The Controller also interfaces with an instance of a `JMS` Queue (`ActiveMQ`), usually on the same instance as the controller. The Message Queue is used to coordinate starting and coordination of the load tests.   
+The Controller can be accessed at the context root of `http://[baseUrlOfAmazonInstance]/tank`
+
+### Agent(s)
+Agent(s) are instantiated on demand and exist for the duration of a test. They communicate with the controller via a combination of RESTful interfaces as well as the Message Queue.
+
+### Optional Components
+Optional components can include a *log aggregator* as well as other instances to be started at the beginning of a test. These are configured in the `settings.xml` and can be stopped and re-used or terminated at the end of a test.
+
+The next few sections will delve deep into the Key Concepts of Tank and Tools that assist in making Load testing with Tank a seamless experience.
diff --git a/mkdocs/docs/installation-guide/.pages b/mkdocs/docs/installation-guide/.pages
@@ -0,0 +1,2 @@
+nav: 
+    - installation.md