Merge branch 'main' into main

Author: DaanHoogland

README.rst

@@ -90,7 +90,7 @@ On your computer, follow these steps to setup a local repository for working on
 .. code:: bash
 
    $ git clone https://github.com/YOUR_ACCOUNT/cloudstack-documentation.git
-   $ cd cloudstack-docs-install
+   $ cd cloudstack-documentation
    $ git remote add upstream https://github.com/apache/cloudstack-documentation.git
    $ git checkout main
    $ git fetch upstream

requirements.txt

@@ -2,4 +2,4 @@ docutils==0.20.1
 Sphinx==7.2.6
 sphinx-rtd-theme==2.0.0
 readthedocs-sphinx-ext==2.2.5
-Jinja2==3.1.3
+Jinja2==3.1.5

source/_static/images/cks-acquire-publicip.png

@@ -676,7 +676,7 @@ For GitHub, please follow the instructions mentioned here `"Setting up OAuth 2.0
 In any OAuth 2.0 configuration admin has to use the redirect URI "http://<management server IP>:<port>/#/verifyOauth"
 
 .. Note:: [Google OAuth 2.0 redirect URI] :
-          Google OAuth 2.0 configuration wont accept '#' in the URI, please use "http://<management server Domain>:<port>/?verifyOauth"
+          Google OAuth 2.0 configuration won't accept '#' in the URI, please use "http://<management server Domain>:<port>/?verifyOauth"
           Google does not accept direct IP address in the redirect URI, it must be a domain. As a workaround one can add the management
           server IP to host table in the local system and assign a domain, something like "management.cloud". In that redirect URI looks like
           "http://management.cloud:8080/?verifyOauth"

source/_static/images/cks-addfirewall.png

@@ -64,12 +64,16 @@ the user data:
 #. Run the following command to find the virtual router.
 
    .. code:: bash
+
       # cat /var/lib/dhclient/dhclient-eth0.leases | grep dhcp-server-identifier | tail -1
+
 #. Access user data by running the following command using the result of
    the above command
 
    .. code:: bash
+
       # curl http://10.1.1.1/latest/user-data
+
 Meta Data can be accessed similarly, using a URL of the form
 http://10.1.1.1/latest/meta-data/{metadata type}. (For backwards
 compatibility, the previous URL http://10.1.1.1/latest/{metadata type}

source/_static/images/cks-addloadbalancer.png

@@ -92,7 +92,7 @@ Backup Offerings
 ------------------
 
 Admins can import an external provider's backup offerings using UI or API for a
-particular zone, as well as manage a backup offering's lifecyle. Admins can also
+particular zone, as well as manage a backup offering's lifecycle. Admins can also
 specify if a backup offering allows user-defined backup schedules and ad-hoc
 backups. Users can list and consume the imported backup offerings, only root admins can import or
 delete offerings.

source/_static/images/cks-addnode.png

@@ -203,6 +203,23 @@ changes can control the behaviour.
 
 #. Restart the Management Server.
 
+#. CloudStack creates the exchange ‘cloudstack-events’ which will receive messages containing CloudStack events; however will be no queues created.
+
+   To create a queue and bind with cloudstack-events the following steps are needed:
+
+   - Go to Queues tab and add a queue, e.g. 'cloudstack-queue’
+   - Go to Exchanges tab and Bind to queue cloudstack-queue with the desired ‘Routing key’.
+
+
+#. Routing keys 
+
+   The routing key is a list of words, delimited by a period ("."). CloudStack builds routing keys according to each event type, some examples are:
+
+   Some example of routing keys that match CloudStack events:
+   - A pound symbol (“#”) indicates a match on zero or more words; thus, it will match any possible set of words; 
+   - Asterisk (“*”) matching any word and the period (“.”) delimiting example '\*.*.*.*.*'
+
+
 Kafka Configuration
 ~~~~~~~~~~~~~~~~~~~
 
@@ -214,7 +231,20 @@ changes can control the behaviour.
    which contains valid kafka configuration properties as documented in http://kafka.apache.org/documentation.html#newproducerconfigs
    The properties may contain an additional ``topic`` property which if not provided will default to ``cloudstack``.
    While ``key.serializer`` and ``value.serializer`` are usually required for a producer to correctly start, they may be omitted and
-   will default to ``org.apache.kafka.common.serialization.StringSerializer``.
+   will default to ``org.apache.kafka.common.serialization.StringSerializer``. A sample example which will be used by cloudstack for exporting of events
+
+   .. parsed-literal::
+
+      cat /etc/cloudstack/management/kafka.producer.properties
+
+      bootstrap.servers=<localhost>:9092
+      acks=all
+      topic=cs
+      retries=1
+    
+
+
+   
 
 #. Create the folder ``/etc/cloudstack/management/META-INF/cloudstack/core``