Skip to content

Commit bbbcaf3

Browse files
Release 0.1.5
Changes: * GUI-fix for not UTC timezone * Update documetation * Fix `loaddata` operation * Add logo See merge request cloud/polemarch!55
2 parents a68eece + ef4197d commit bbbcaf3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+2284
-530
lines changed

doc/conf.py

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747

4848
# General information about the project.
4949
project = 'Polemarch'
50-
copyright = '2017, VST Consulting'
50+
copyright = '2018, VST Consulting'
5151
author = 'VST Consulting'
5252

5353
# The version info for the project you're documenting, acts as replacement for
@@ -83,35 +83,23 @@
8383
# The theme to use for HTML and HTML Help pages. See the documentation for
8484
# a list of builtin themes.
8585
#
86-
html_theme = 'alabaster'
87-
86+
html_theme_path=['.']
87+
html_theme = 'polemarch-sphinx-theme'
8888
# Theme options are theme-specific and customize the look and feel of a theme
8989
# further. For a list of options available for each theme, see the
9090
# documentation.
91-
#
91+
9292
html_theme_options = {
93-
"description": "Polemarch Documentation",
9493
"github_user": "vstconsulting",
9594
"github_repo": "polemarch",
9695
"github_button": True,
9796
"github_banner": True,
98-
"show_powered_by": False,
99-
}
100-
101-
html_sidebars = {
102-
'**': [
103-
'about.html',
104-
'navigation.html',
105-
'relations.html',
106-
'searchbox.html',
107-
'donate.html',
108-
]
10997
}
11098

11199
# Add any paths that contain custom static files (such as style sheets) here,
112100
# relative to this directory. They are copied after the builtin static files,
113101
# so a file named "default.css" will overwrite the builtin "default.css".
114-
html_static_path = ['_static']
102+
html_static_path = ['_static', '../polemarch/static']
115103

116104

117105
# -- Options for HTMLHelp output ------------------------------------------

doc/gui.rst

Lines changed: 110 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,163 @@
11
GUI workflow
22
==============
33

4+
Welcome to Polemarch GUI
5+
------------------------
6+
7+
In this section of our documentation we will tell you about Polemarch GUI's opportunities.
8+
9+
Let's begin with Dashboard page:
10+
11+
.. image:: gui_png/new-dashboard-1.png
12+
13+
As you can see, Polemarch GUI provides user with 2 menus:
14+
15+
* the first one is located in the left sidebar and it is aimed
16+
to provide user with navigation between main system objects, like projects, templates, history records and ect.
17+
18+
* the second one is located in the top right conner of browser window and it is aimed
19+
to navigate user to API section, to user's page and to logout page.
20+
21+
Also there are some widgets on content block of Dashboard page. User can customize Dashboard page as he wish.
22+
For example, user can change widgets' position, hide some widgets or collapse them.
23+
24+
To change widgets' position user should click on 'lock' button. After this button has been clicked,
25+
user is able to change widgets' position by Drag and Drop.
26+
27+
To collapse or to hide/show some widgets user should click on 'cogwheel' button. After this button has been clicked,
28+
Polemarch opens modal window, where user can activate or collapse some widgets.
29+
30+
To see all these features in work look at next gif-image:
31+
32+
.. image:: gui_gif1/new-dashboard-1.gif
33+
34+
35+
436
Before you start
537
----------------
638

739
Before you can do any job with Polemarch you should create at least one
840
inventory with your servers enumeration and at least one project, because all
941
Polemarch's functions are linked to the project.
1042

11-
Here how you can create inventory and place your hosts and groups there:
43+
Let's start with creation of inventory:
1244

13-
.. image:: gui_gif/create_inventory.gif
45+
.. image:: gui_png/new-inventories_page.png
1446

15-
Also you can import Ansible inventory file:
47+
There are 2 ways of inventory's creation:
1648

17-
.. image:: gui_gif/import_inventory.gif
49+
* the first one is to create inventory manually. To do it user should click on 'Create' button.
1850

19-
Create project. Be aware that your project must have "OK" status, because your
20-
playbooks won't work until Polemarch done synchronization with repository.
21-
If you made everything right, project playbooks will be shown in suggestions
22-
in playbook execution page.
51+
* the second on is to import inventory from text file. To do it user should click on 'Import from file' button.
2352

24-
If you don't have git repository, you can upload tar archive with project files
25-
from any http url.
53+
By inventory's creation, in this case, we understand creation of inventory, which includes at least one group,
54+
which, in it's turn, includes at least one host. In other words, beside inventory user should create host and group.
2655

27-
Also there is special type of project - empty project (MANUAL). In case you
28-
want run only modules without any playbooks or something. Polemarch will
29-
create folder for your project files in `projects_dir` (you can specify
30-
in settings) named as project id (you can see at URL), where you manually
31-
place your project files (like playbooks or something).
56+
To understand it better let's look at next gif-images:
3257

33-
Polemarch will scan project dir root for any .yml file and provide possibility
34-
to run them. So place available playbook targets at root of your Git repository
35-
or tar-archive or folder with your project files.
58+
Here you can see how user can create inventory and place his hosts and groups there manually:
3659

37-
.. image:: gui_gif/create_projects.gif
60+
.. image:: gui_gif1/new-create_inventory_manually.gif
3861

39-
If you update something in your git repository, don't forget to run sync in
40-
Polemarch for pulling your changes.
62+
And here you can see how user can import Ansible inventory file:
63+
64+
.. image:: gui_gif1/new-import_inventory.gif
65+
66+
Futher to start your work with Polemarch you should create project.
4167

42-
.. image:: gui_gif/sync_project.gif
68+
There are 3 project types in Polemarch:
4369

44-
Also maybe you want create separate user for yourself and some other members of
45-
your team:
70+
* GIT - Polemarch can sync with your git project.
4671

47-
.. image:: gui_gif/create_user.gif
72+
* TAR - If you don't have git repository, you can upload tar archive with project files
73+
from any http url.
74+
75+
* MANUAL - Empty project. This kind of project will be appropriate for you,
76+
if you want run only modules without any playbooks or something. Polemarch will
77+
create folder for your project files in `projects_dir` (you can specify it
78+
in settings) named as project id (you can see at URL), where you
79+
place manually your project files (like playbooks or something).
80+
81+
Let's look at the example of GIT project's creation:
82+
83+
.. image:: gui_gif1/new-create_git_project.gif
84+
85+
As you can see at the gif-image above for GIT project
86+
it is possible to choose a branch to what user want to sync. In this example user has synced
87+
his GIT project from 'master' branch to 'other' branch. 'Arrow' icon in the branch input field
88+
shows us, that project will be sync from one branch to another. If there is no 'arrow' icon, it means,
89+
that next time project will be sync to the same branch as you can see it in 'Branch' input field.
90+
91+
If you update something in your GIT repository, don't forget to run sync in
92+
Polemarch for pulling your changes.
93+
94+
After your project's status has changed into "OK" you can confidently start working with Polemarch.
4895

4996
Execution of playbook and modules
5097
---------------------------------
5198

5299
Ok, we made all preparations and ready to do some real work. Let's start by
53100
executing some command on your servers:
54101

55-
.. image:: gui_gif/quick_run_command.gif
102+
.. image:: gui_gif1/new-run_shell_command.gif
56103

57-
Of course you can run any Ansible modules and any of playbooks in your project.
58-
Also you can cancel your tasks if you want:
104+
As you can see at the gif-image above
105+
when task has stopped running it become possible to clear ansible stdout.
59106

60-
.. image:: gui_gif/run_something.gif
107+
Also you can run any Ansible modules and any of playbooks in your project.
61108

62-
Almost everywhere in Polemarch you can filter your data. Let see for example
63-
how filter your execution history records to find result of needed action:
109+
Polemarch will scan project dir root for any .yml file and provide possibility
110+
to run them. So place available playbook targets at root of your Git repository
111+
or tar-archive or folder with your project files.
112+
113+
Be aware that your project must have "OK" status, because your
114+
playbooks won't work until Polemarch done synchronization with repository.
115+
If you made everything right, project playbooks will be shown in suggestions
116+
in playbook execution page.
117+
118+
Let's look at the example of running some playbook, which Polemarch imported from GIT repository
119+
of our project:
120+
121+
.. image:: gui_gif1/new-running_playbook.gif
64122

65-
.. image:: gui_gif/filter_history.gif
66123

67124
Templates
68125
---------
69126

70127
If you have many arguments, which you pass to Ansible at every task run (like
71-
extra-vars, forks number ans so on), you can create template for such action
128+
extra-vars, forks number and so on), you can create template for such action
72129
to minimize hand work (either module run or playbook):
73130

74-
.. image:: gui_gif/module_template.gif
131+
.. image:: gui_gif1/new-create_template.gif
132+
133+
Sometimes your need to keep some similar templates, which are different by only several parameters.
134+
In this case template options will be extremly useful for you. In every template you can create
135+
a lot of options which can modify this template by some parameters. Let's look at the example:
136+
137+
.. image:: gui_gif1/new-create_template_option.gif
75138

76-
.. image:: gui_gif/task_template.gif
77139

78140
Also you can backup/share your templates using import/export mechanism:
79141

80-
.. image:: gui_gif/import_template.gif
142+
.. image:: gui_gif1/new-export-import-template.gif
81143

82144
Periodic tasks
83145
--------------
84146

85-
If you want to run some actions to run by schedule without any control from
86-
you, it possible with Polemarch. You can create periodic tasks, which runs
87-
every X seconds (interval based). You can even check those tasks using
88-
"Run now" command:
147+
If you want to run some actions by schedule without any control from
148+
you, it is possible with Polemarch. You can create periodic tasks, which runs
149+
every X seconds (interval based):
89150

90-
.. image:: gui_gif/ptask_module_interval.gif
151+
.. image:: gui_gif1/new-create-periodic-task-interval.gif
91152

92153
Also you can create periodic tasks with more advancing scheduling options
93154
(days of week, hours, month and so on) by using cron-style periodic tasks:
94155

95-
.. image:: gui_gif/ptask_playbook_cron.gif
156+
.. image:: gui_gif1/new-create-periodic-schedule.gif
157+
158+
Search
159+
------
160+
Almost everywhere in Polemarch you can filter your data. Let see for example
161+
how to filter your execution history records to find result of needed action:
162+
163+
.. image:: gui_gif1/new-search2.gif
3.41 MB
Loading
1.85 MB
Loading
475 KB
Loading
1.61 MB
Loading

doc/gui_gif1/create_template.gif

1.41 MB
Loading
3.22 MB
Loading

doc/gui_gif1/dashboard-1.gif

2.42 MB
Loading
1.78 MB
Loading

0 commit comments

Comments
 (0)