Skip to content

Commit de986ba

Browse files
kkinchkkinch
committed
Update README.rst and conf.py
1 parent f9ce638 commit de986ba

File tree

2 files changed

+29
-20
lines changed

2 files changed

+29
-20
lines changed

‎docs/README.rst‎

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -139,23 +139,33 @@ General
139139
BIG-IP system
140140
`````````````
141141

142-
+-----------------------+---------+----------+-------------------+-----------------------------------------+----------------+
143-
| Parameter | Type | Required | Default | Description | Allowed Values |
144-
+=======================+=========+==========+===================+=========================================+================+
145-
| bigip-partition | string | Required | n/a | The BIG-IP partition in which | |
146-
| | | | | to configure objects. | |
147-
+-----------------------+---------+----------+-------------------+-----------------------------------------+----------------+
148-
| bigip-password | string | Required | n/a | BIG-IP iControl REST password | |
149-
| | | | | [#secrets]_ | |
150-
+-----------------------+---------+----------+-------------------+-----------------------------------------+----------------+
151-
| bigip-url | string | Required | n/a | BIG-IP admin IP address | |
152-
+-----------------------+---------+----------+-------------------+-----------------------------------------+----------------+
153-
| bigip-username | string | Required | n/a | BIG-IP iControl REST username | |
154-
| | | | | [#username]_ | |
155-
+-----------------------+---------+----------+-------------------+-----------------------------------------+----------------+
156-
| credentials-directory | string | Optional | n/a | Directory that contains the BIG-IP | |
157-
| | | | | username, password, or url files | |
158-
+-----------------------+---------+----------+-------------------+-----------------------------------------+----------------+
142+
+-----------------------+---------+----------+-------------------+--------------------------------------------+----------------+
143+
| Parameter | Type | Required | Default | Description | Allowed Values |
144+
+=======================+=========+==========+===================+============================================+================+
145+
| bigip-partition | string | Required | n/a | The BIG-IP partition in which | |
146+
| | | | | to configure objects. | |
147+
+-----------------------+---------+----------+-------------------+--------------------------------------------+----------------+
148+
| bigip-password | string | Required | n/a | BIG-IP iControl REST password | |
149+
| | | | | | |
150+
| | | | | You can `secure your BIG-IP credentials`_ | |
151+
| | | | | using a Kubernetes Secret. | |
152+
+-----------------------+---------+----------+-------------------+--------------------------------------------+----------------+
153+
| bigip-url | string | Required | n/a | BIG-IP admin IP address | |
154+
+-----------------------+---------+----------+-------------------+--------------------------------------------+----------------+
155+
| bigip-username | string | Required | n/a | BIG-IP iControl REST username | |
156+
| | | | | | |
157+
| | | | | The BIG-IP user account must have the | |
158+
| | | | | appropriate role defined: | |
159+
| | | | | | |
160+
| | | | | For ``nodeport`` type pool members, the | |
161+
| | | | | role must be ``Administrator``. | |
162+
| | | | | | |
163+
| | | | | For ``cluster`` type pool members, the | |
164+
| | | | | role must be ``Administrator``. | |
165+
+-----------------------+---------+----------+-------------------+--------------------------------------------+----------------+
166+
| credentials-directory | string | Optional | n/a | Directory that contains the BIG-IP | |
167+
| | | | | username, password, or url files | |
168+
+-----------------------+---------+----------+-------------------+--------------------------------------------+----------------+
159169

160170
.. important::
161171

@@ -231,7 +241,7 @@ Kubernetes
231241
| | | | | only nodes with this label | |
232242
+-----------------------+---------+----------+-------------------+-----------------------------------------+----------------+
233243
| pool-member-type | string | Optional | nodeport | The type of BIG-IP pool members you want| cluster, |
234-
| | | | | to create. [#username]_ | nodeport |
244+
| | | | | to create. | nodeport |
235245
| | | | | | |
236246
| | | | | Use ``cluster`` to create pool members | |
237247
| | | | | for each of the endpoints for the | |
@@ -804,8 +814,6 @@ OpenShift
804814
.. rubric:: **Footnotes**
805815
.. [#objectpartition] The |kctlr| creates and manages objects in the BIG-IP partition defined in the `F5 resource`_ ConfigMap. **It cannot manage objects in the** ``/Common`` **partition**.
806816
.. [#nodeportmode] The |kctlr| forwards traffic to the NodePort assigned to the Service by Kubernetes. See the `Kubernetes Service`_ documentation for more information.
807-
.. [#secrets] You can `secure your BIG-IP credentials`_ using a Kubernetes Secret.
808-
.. [#username] The BIG-IP user account must have an appropriate role defined. For ``nodeport`` type pool members, this role must be either ``Administrator``, ``Resource Administrator``, or ``Manager``. For ``cluster`` type pool members, the user account must have either the ``Administrator`` or ``Resource Manager`` role. See `BIG-IP Users <https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/tmos-concepts-11-5-0/10.html>`_ for further details.
809817
.. [#lb] The |kctlr| supports BIG-IP load balancing algorithms that do not require additional configuration parameters. You can view the full list of supported algorithms in the `f5-cccl schema <https://github.com/f5devcentral/f5-cccl/blob/03e22c4779ceb88f529337ade3ca31ddcd57e4c8/f5_cccl/schemas/cccl-ltm-api-schema.yml#L515>`_. See the `BIG-IP Local Traffic Management Basics user guide <https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/ltm-basics-13-0-0/4.html>`_ for information about each load balancing mode.
810818
.. [#ba] The Controller supports BIG-IP `route domain`_ specific addresses.
811819
.. [#ssl] If you want to configure multiple SSL profiles, use ``f5ProfileNames`` instead of ``f5ProfileName``. The two parameters are mutually exclusive.

‎docs/conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
'sphinxjp.themes.basicstrap',
4444
'sphinx.ext.extlinks',
4545
'recommonmark',
46+
'sphinx_copybutton',
4647
'cloud_sptheme.ext.table_styling'
4748
]
4849

0 commit comments

Comments
 (0)