Browse Source

Merge "Adding address function to doc"

Jenkins 2 years ago
parent
commit
dcf1cd736d
1 changed files with 48 additions and 0 deletions
  1. 48
    0
      doc/source/config/types.rst

+ 48
- 0
doc/source/config/types.rst View File

@@ -58,6 +58,7 @@ a part of groups mentioned erlier.
58 58
 - :ref:`network_topology`
59 59
 - :ref:`ccp_node`
60 60
 - :ref:`ccp_pod`
61
+- :ref:`address`
61 62
 
62 63
 List of keys
63 64
 ~~~~~~~~~~~~
@@ -600,3 +601,50 @@ For example:
600 601
 ::
601 602
 
602 603
     my_pod = "{{ pod_name }}"
604
+
605
+.. _address:
606
+
607
+address
608
+-------
609
+
610
+Isolation:
611
+
612
+- Used in service templates files (service/files/).
613
+
614
+- Used in application definition file service/component_name.yaml.
615
+
616
+Allowed content:
617
+
618
+- This is a function with the following params:
619
+
620
+.. list-table::
621
+   :widths: 10 25 10 10
622
+   :header-rows: 1
623
+
624
+   * - Parameter
625
+     - Description
626
+     - Required
627
+     - Default
628
+   * - service
629
+     - Name of the service.
630
+     - True
631
+     - --
632
+   * - port
633
+     - Add port to the url. Port config section should be specified.
634
+     - False
635
+     - --
636
+   * - external
637
+     - Use external url instead of internal.
638
+     - False
639
+     - False
640
+   * - with_scheme
641
+     - Add scheme to the url.
642
+     - False
643
+     - False
644
+
645
+You could use it to get address of the service. For example:
646
+
647
+::
648
+
649
+    service_address = "{{ address('keystone', keystone.public_port, external=True, with_scheme=True) }}"
650
+

Loading…
Cancel
Save