openstack/freezer-web-ui
Code Issues Proposed changes

Add freezer dashboard documentation to html files

Browse Source 
Visual clues for Actions, Jobs and Sessions windows

Change-Id: Ide863c5eff253f181fa77fc5c9334baeb4fb914d
This commit is contained in:
Memo Garcia 2015-07-31 01:48:49 +01:00 committed by Fausto Marzi
parent c231fbff22
commit becf86a8f1
14 changed files with 68 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
freezer_ui/backups/templates/backups/index.html
View File

@ -6,10 +6,10 @@
{% endblock %}
{% load i18n %}
{% block title %}{% trans "Backup History" %}{% endblock %}
{% block title %}{% trans "Backups" %}{% endblock %}
{% block page_header %}
{% include "horizon/common/_page_header.html" with title=_("Backup History") %}
{% include "horizon/common/_page_header.html" with title=_("Backups") %}
{% endblock page_header %}
{% block main %}

4
freezer_ui/jobs/tables.py
View File

@ -154,7 +154,7 @@ class JobsTable(tables.DataTable):
verbose_name=_("Job Name"))
result = tables.Column("result",
verbose_name=_("Last Result"))
verbose_name=_("Job Result"))
def get_object_id(self, backup_config):
return backup_config.id
@ -225,7 +225,7 @@ class ObjectFilterAction(tables.FilterAction):
class ActionsTable(tables.DataTable):
action_name = tables.Column('action',
verbose_name=_("Action"))
verbose_name=_("Action Type"))
backup_name = tables.Column('backup_name',
verbose_name=_("Action Name"))

9
freezer_ui/jobs/templates/jobs/_action.html
View File

@ -1,6 +1,15 @@
{% load i18n horizon humanize %}
{% block help_message %}
<h4>{% blocktrans %}Action{% endblocktrans %}</h4>
<p>{% blocktrans %}Specify the details for this action.{% endblocktrans %}</p>
<p>{% blocktrans %}An action is the simplest execution within a job, it could be a backup or a restore
and it contains rules that the action must follow (max retries, interval between intervals, etc)
.{% endblocktrans %}</p>
{% endblock %}
<script type='text/javascript' src='{{ STATIC_URL }}freezer/js/freezer.actions.action.js'></script>

5
freezer_ui/jobs/templates/jobs/_advanced.html
View File

@ -1,6 +1,11 @@
{% load i18n horizon humanize %}
{% block help_message %}
<h4>{% blocktrans %}Advanced configuration{% endblocktrans %}</h4>
<p>{% blocktrans %}Define extra information for the action to execute in the client.{% endblocktrans %}</p>
{% endblock %}
<script type='text/javascript' src='{{ STATIC_URL }}freezer/js/freezer.actions.advanced.js'></script>

11
freezer_ui/jobs/templates/jobs/_info.html Normal file
View File

@ -0,0 +1,11 @@
{% load i18n horizon humanize %}
{% block help_message %}
<h4>{% blocktrans %}Job{% endblocktrans %}</h4>
<p>{% blocktrans %}Specify the details for creating a job.{% endblocktrans %}</p>
<p>{% blocktrans %}A job defines an ordered list of actions to be executed in a client with scheduling information.{% endblocktrans %}</p>
{% endblock %}

11
freezer_ui/jobs/templates/jobs/_rules.html Normal file
View File

@ -0,0 +1,11 @@
{% load i18n horizon humanize %}
{% block help_message %}
<h4>{% blocktrans %}Rules{% endblocktrans %}</h4>
<p>{% blocktrans %}Define rules for this action, from how many times it will retry the action, the interval
between interval and whether or not the action is mandatory. {% endblocktrans %}</p>
{% endblock %}

6
freezer_ui/jobs/templates/jobs/_snapshot.html
View File

@ -1,6 +1,12 @@
{% load i18n horizon humanize %}
{% block help_message %}
<h4>{% blocktrans %}Action{% endblocktrans %}</h4>
<p>{% blocktrans %}Specify weather this action should execute a snapshot on the client file system.
In Linux and it's distros it will use LVM and in Windows it will use Volume Shadow Copy{% endblocktrans %}</p>
{% endblock %}
<script type='text/javascript' src='{{ STATIC_URL }}freezer/js/freezer.actions.snapshot.js'></script>

4
freezer_ui/jobs/templates/jobs/browser.html
View File

@ -1,9 +1,9 @@
{% extends 'base.html' %}
{% load i18n %}
{% block title %}{% trans "Job Configurations" %}{% endblock %}
{% block title %}{% trans "Jobs" %}{% endblock %}
{% block page_header %}
{% include "horizon/common/_page_header.html" with title=_("Job Configurations") %}
{% include "horizon/common/_page_header.html" with title=_("Jobs") %}
{% endblock page_header %}
{% block main %}

2
freezer_ui/jobs/workflows/action.py
View File

@ -565,6 +565,8 @@ class RulesConfigurationAction(workflows.Action):
class Meta(object):
name = _("Rules")
help_text_template = "freezer_ui/jobs" \
"/_rules.html"
class RulesConfiguration(workflows.Step):

2
freezer_ui/jobs/workflows/configure.py
View File

@ -166,6 +166,8 @@ class InfoConfigurationAction(workflows.Action):
class Meta(object):
name = _("Job Info")
slug = "info"
help_text_template = "freezer_ui/jobs" \
"/_info.html"
class InfoConfiguration(workflows.Step):

12
freezer_ui/sessions/templates/sessions/_info.html Normal file
View File

@ -0,0 +1,12 @@
{% load i18n horizon humanize %}
{% block help_message %}
<h4>{% blocktrans %}Session{% endblocktrans %}</h4>
<p>{% blocktrans %}Specify the name for this session.{% endblocktrans %}</p>
<p>{% blocktrans %}A session is a collection of jobs which share scheduling information and will coordinate one
or more clients.{% endblocktrans %}</p>
{% endblock %}

4
freezer_ui/sessions/templates/sessions/browser.html
View File

@ -1,9 +1,9 @@
{% extends 'base.html' %}
{% load i18n %}
{% block title %}{% trans "Session Configurations" %}{% endblock %}
{% block title %}{% trans "Sessions" %}{% endblock %}
{% block page_header %}
{% include "horizon/common/_page_header.html" with title=_("Session Configurations") %}
{% include "horizon/common/_page_header.html" with title=_("Sessions") %}
{% endblock page_header %}
{% block main %}

2
freezer_ui/sessions/workflows/create_session.py
View File

@ -34,6 +34,8 @@ class SessionConfigurationAction(workflows.Action):
class Meta:
name = _("Session Information")
slug = "sessions"
help_text_template = "freezer_ui/sessions" \
"/_info.html"
class SessionConfiguration(workflows.Step):

9
freezer_ui/static/freezer/js/freezer.actions.action.js
View File

@ -104,18 +104,15 @@ $("#id_storage").change(function() {
if ($("#id_storage").val() == 'swift') {
hideEverything();
showBackupOptions();
$("#id_mode").closest(".form-group").hide();
}
else if ($("#id_storage").val() == 'ssh') {
hideEverything();
showBackupOptions();
$("#id_mode").closest(".form-group").hide();
showSSHOptions();
}
else if ($("#id_storage").val() == 'local') {
hideEverything();
showBackupOptions();
$("#id_mode").closest(".form-group").hide();
}
else {
hideEverything();
@ -128,40 +125,34 @@ $("#id_mode").change(function() {
if ($("#id_mode").val() == 'fs') {
hideEverything();
showBackupOptions();
$("#id_advanced_configuration").closest(".form-group").show();
}
else if ($("#id_mode").val() == 'mysql') {
hideEverything();
showBackupOptions();
$("#id_mysql_conf").closest(".form-group").show();
$("#id_sql_server_conf").closest(".form-group").hide();
$("#id_advanced_configuration").closest(".form-group").show();
}
else if ($("#id_mode").val() == 'mssql') {
hideEverything();
showBackupOptions();
$("#id_sql_server_conf").closest(".form-group").show();
$("#id_mysql_conf").closest(".form-group").hide();
$("#id_advanced_configuration").closest(".form-group").show();
}
else if ($("#id_mode").val() == 'mongo') {
hideEverything();
showBackupOptions();
$("#id_sql_server_conf").closest(".form-group").hide();
$("#id_mysql_conf").closest(".form-group").hide();
$("#id_advanced_configuration").closest(".form-group").show();
}
else if ($("#id_mode").val() == 'cinder') {
hideEverything();
showCinderOptions();
$("#id_cinder_vol_id").closest(".form-group").show().addClass("required");
$("#id_advanced_configuration").closest(".form-group").show();
}
else if ($("#id_mode").val() == 'nova') {
hideEverything();
showNovaOptions();
$("#id_nova_inst_id").closest(".form-group").show().addClass("required");
$("#id_advanced_configuration").closest(".form-group").show();
}
else {