From db3eec2bc1830baeaaec9209b4f242f6559db698 Mon Sep 17 00:00:00 2001
From: dereknoblej <48695318+dereknoblej@users.noreply.github.com>
Date: Mon, 11 Mar 2024 13:35:59 -0500
Subject: [PATCH] DOC: Openstack Floating Ips (#142)

* DOC: Openstack Floating Ips

* forgot some changes
---
 docs/openstack-floating-ips.md | 88 ++++++++++++++++++++++++++++++++++
 mkdocs.yml                     |  1 +
 2 files changed, 89 insertions(+)
 create mode 100644 docs/openstack-floating-ips.md

diff --git a/docs/openstack-floating-ips.md b/docs/openstack-floating-ips.md
new file mode 100644
index 00000000..d8cc37e9
--- /dev/null
+++ b/docs/openstack-floating-ips.md
@@ -0,0 +1,88 @@
+# Openstack Floating Ips
+
+To read more about Openstack Floating Ips using the [upstream docs](https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/floating-ip.html).
+
+#### List and view floating ips
+
+``` shell
+$ openstack floating ip list
+    [--network <network>]
+    [--port <port>]
+    [--fixed-ip-address <ip-address>]
+    [--long]
+    [--status <status>]
+    [--project <project> [--project-domain <project-domain>]]
+    [--router <router>]
+```
+
+#### Create a floating ip
+
+``` shell
+$ openstack floating ip create
+    [--subnet <subnet>]
+    [--port <port>]
+    [--floating-ip-address <ip-address>]
+    [--fixed-ip-address <ip-address>]
+    [--description <description>]
+    [--project <project> [--project-domain <project-domain>]]
+    <network>
+```
+
+#### Delete a floating ip(s)
+
+!!! note
+
+    Ip address or ID can be used to specify which ip to delete.
+
+
+``` shell
+$ openstack floating ip delete <floating-ip> [<floating-ip> ...]
+```
+
+#### Floating ip set
+
+Set floating IP properties
+
+``` shell
+$ openstack floating ip set
+    --port <port>
+    [--fixed-ip-address <ip-address>]
+    <floating-ip>
+```
+
+#### Display floating ip details
+
+``` shell
+$ openstack floating ip show <floating-ip>
+```
+
+#### Unset floating IP Properties
+
+``` shell
+$ openstack floating ip unset
+    --port
+    <floating-ip>
+```
+
+#### Associate floating IP addresses
+
+You can assign a floating IP address to a project and to an instance.
+
+Associate an IP address with an instance in the project, as follows:
+
+``` shell
+$ openstack server add floating ip INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS
+```
+
+#### Disassociate floating IP addresses
+
+To disassociate a floating IP address from an instance:
+
+``` shell
+$ openstack server remove floating ip INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS
+```
+To remove the floating IP address from a project:
+
+``` shell
+$ openstack floating ip delete FLOATING_IP_ADDRESS
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 420529ca..a57f1160 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -199,3 +199,4 @@ nav:
           - OSIE: extra-osie.md
   - Cloud Onboarding:
       - Openstack Security Groups: openstack-security-groups.md
+      - Openstack Floating Ips: openstack-floating-ips.md