Skip to content
This repository has been archived by the owner on Feb 27, 2020. It is now read-only.

Commit

Permalink
Jenkins checking in autogenerated rST files
Browse files Browse the repository at this point in the history
  • Loading branch information
AthenaNebula Jenkins committed Jun 12, 2017
1 parent 3208bfc commit 00f3328
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 31 deletions.
4 changes: 2 additions & 2 deletions autogenerated_rst_docs/Backups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ To backup the shared configuration:
/etc/clearwater/enum.json
/etc/clearwater/s-cscf.json
/etc/clearwater/shared_ifcs.xml
/etc/clearwater/default_ifcs.xml
/etc/clearwater/fallback_ifcs.xml

Restoring Configuration
~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -361,7 +361,7 @@ commands on that node:
cw-upload_enum_json
cw-upload_scscf_json
cw-upload_shared_ifcs_xml
cw-upload_default_ifcs_xml
cw-upload_fallback_ifcs_xml

See `Modifying Clearwater settings <Modifying_Clearwater_settings.html>`__
for more details on this.
Original file line number Diff line number Diff line change
Expand Up @@ -604,9 +604,9 @@ e.g. ``icscf=5052``).
iFC sets from the HSS. This option is enabled by default. Shared iFC
sets can be configured on Clearwater in the
``/etc/clearwater/shared_ifcs.xml`` file.
- ``apply_default_ifcs`` - when set to 'Y' Clearwater will apply any
default iFCs specified by the operator in the
``/etc/clearwater/default_ifcs.xml`` file to initial requests who
- ``apply_fallback_ifcs`` - when set to 'Y' Clearwater will apply any
fallback iFCs specified by the operator in the
``/etc/clearwater/fallback_ifcs.xml`` file to initial requests who
have no applicable iFCs associated with them. This option is not
enabled by default.
- ``reject_if_no_matching_ifcs`` - when set to 'Y' Clearwater will
Expand Down
4 changes: 2 additions & 2 deletions autogenerated_rst_docs/Clearwater_SNMP_Statistics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,8 @@ Sprout nodes provide the following statistics:
S-CSCF has no matching set of iFCs, indexed by time period.
- The number of initial requests that had no matching iFCs to apply,
indexed by time period.
- The number of initial requests that attempted to use Default iFCs but
had no matching ones, indexed by time period.
- The number of initial requests that attempted to use fallback iFCs
but had no matching ones, indexed by time period.
- The number of requests rejected because an identity was barred.

Vellum statistics
Expand Down
6 changes: 3 additions & 3 deletions autogenerated_rst_docs/Handling_Multiple_Failed_Nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,11 @@ site:

- Verify that the ``/etc/clearwater/shared_ifcs.xml`` file is correct,
fixing it up if it's not.
- verify that the ``/etc/clearwater/default_ifcs.xml`` file is correct,
fixing it up if it's not.
- Verify that the ``/etc/clearwater/fallback_ifcs.xml`` file is
correct, fixing it up if it's not.

Running one of the commands
``sudo cw-validate_{shared|default}_ifcs_xml`` will check if the
``sudo cw-validate_{shared|fallback}_ifcs_xml`` will check if the
specified file is syntactically correct.

Recreate the etcd cluster
Expand Down
37 changes: 19 additions & 18 deletions autogenerated_rst_docs/Manual_Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -605,41 +605,42 @@ Sprout node the file is present on.
To remove the Shared iFC configuration, run the command
``sudo cw-remove_shared_ifcs_xml`` on any Sprout node.

Default iFC configuration
~~~~~~~~~~~~~~~~~~~~~~~~~
Fallback iFC configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~

If you wish to apply iFCs by default to any subscribers who have no iFCs
triggered on a request, these iFCs must be configured on the S-CSCF, and
the configuration option ``apply_default_ifcs`` set to 'Y'.
If you wish to apply iFCs to any subscribers who have no iFCs triggered
on a request (e.g. as a fallback to catch misconfigured subscribers),
these iFCs must be configured on the S-CSCF, and the configuration
option ``apply_fallback_ifcs`` set to 'Y'.

You can configure Default iFCs on the S-CSCF by editing the
``/etc/clearwater/default_ifcs.xml`` file.
You can configure fallback iFCs on the S-CSCF by editing the
``/etc/clearwater/fallback_ifcs.xml`` file.

This file stores a list of Default iFCs. The format of the file is as
This file stores a list of fallback iFCs. The format of the file is as
follows:

::

<?xml version="1.0" encoding="UTF-8"?>
<DefaultIFCsSet>
<FallbackIFCsSet>
<InitialFilterCriteria>
<iFC>
</InitialFilterCriteria>
</DefaultIFCsSet>
</FallbackIFCsSet>

The ``iFC`` is an iFC, in XML format.

There must be exactly one ``DefaultIFCsSet`` element, which can can
There must be exactly one ``FallbackIFCsSet`` element, which can can
contain multiple ``InitialFilterCriteria`` elements (the minimum number
of ``InitialFilterCriteria`` elements is zero).

To change the Default iFC configuration, edit this file on any Sprout
To change the fallback iFC configuration, edit this file on any Sprout
node, then upload it to the shared configuration database by running
``sudo cw-upload_default_ifcs_xml``.
``sudo cw-upload_fallback_ifcs_xml``.

To validate the Default iFC configuration file before uploading it, run
the command ``sudo cw-validate_default_ifcs_xml <file_location>`` on the
Sprout node the file is present on.
To validate the fallback iFC configuration file before uploading it, run
the command ``sudo cw-validate_fallback_ifcs_xml <file_location>`` on
the Sprout node the file is present on.

To remove the Default iFC configuration, run the command
``sudo cw-remove_default_ifcs_xml`` on any Sprout node.
To remove the fallback iFC configuration, run the command
``sudo cw-remove_fallback_ifcs_xml`` on any Sprout node.
6 changes: 3 additions & 3 deletions autogenerated_rst_docs/Modifying_Clearwater_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ files.

- ``/etc/clearwater/shared_ifcs.xml`` - contains information about all
Shared iFC sets for the Sprout S-CSCF to use.
- ``/etc/clearwater/default_ifcs.xml`` - contains information about all
the Default iFCs for the Sprout S-CSCF to apply.
- ``/etc/clearwater/fallback_ifcs.xml`` - contains information about
all the fallback iFCs for the Sprout S-CSCF to apply.

To change one of these files:

- Edit the file on *one* of your sprout nodes in each site.
- Run one of ``sudo cw-upload_{shared|default}_ifcs_xml`` depending on
- Run one of ``sudo cw-upload_{shared|fallback}_ifcs_xml`` depending on
which file you modified.
- The change will be automatically propogated around the site (by
Clearwater's `automatic configuration
Expand Down

0 comments on commit 00f3328

Please sign in to comment.