Skip to content

Commit 83334a6

Browse files
committed
cloud-init cli
1 parent e65c6a1 commit 83334a6

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

docs/rseries_deploying_a_tenant.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,9 @@ Before deploying any tenant, you must ensure you have a proper tenant software r
257257

258258
.. Note:: F5 changed the way that tenant images are signed in October 2025. You should ensure you download the proper image format based on the version of F5OS you are running. Going forward the **qcow2.zip.bundle** is being replaced in favor of the **tar.bundle** format. Please see the following solution article for more details.
259259

260+
`K000157005: F5 signing certificate and key rotation, October 2025 <https://my.f5.com/manage/s/article/K000157005>`_
261+
262+
260263
.. code-block:: bash
261264
262265
scp BIGIP-15.1.5-0.0.8.ALL-F5OS.qcow2.zip.bundle admin@10.255.0.132:IMAGES
@@ -609,6 +612,46 @@ To see the actual status of the tenants, issue the CLI command **show tenants**.
609612
----------------------------------------------------------------------------------------------------------------------------------------
610613
1 cloud-init3-1 1 1 Running 2026-05-05T23:41:14Z 2026-05-05T23:41:16Z Started tenant instance 00:94:a1:69:35:1b
611614
615+
Levergaing Cloud-Init via CLI
616+
=============================
617+
618+
Cloud-Init is the industry standard start-up agent installed on virtual machines to facilitate cloud deployments. F5OS v2.0 added the capability of leveraging **cloud-init** to define certain BIG-IP configuration items via a cloud-init script that is run when the TMOS tenant boots. You can speed up the initialization of your BIG-IP instance by passing user-data to perform tasks like onboarding and configuring BIG-IP. For example, to pass user-data you can use a bash startup script or cloud-init’s built-in yaml-based configuration file, a cloud-config file. More details on cloud-init usgae on BIG-IP VE can be found here:
619+
620+
`Cloud-Init and F5 BIG-IP Virtual Edition <https://clouddocs.f5.com/cloud/public/v1/shared/cloudinit.html>`_
621+
622+
In F5OS, you can define a cloud-init script via the CLI, API, or WebUI or alternatively you can upluad or import a cloud-init script into F5OS which has been created externally.
623+
624+
Before applying a cloud-init script to an F5OS tenant you must create a cloud-init configuration object, then that cloud-init object can be referenced within a tenant configuration. Below is an example of creating a cloud-init script and giving it a name of **test** via the F5OS CLI using the **cloud-inits cloud-init test config user-data** command:
625+
626+
627+
.. code-block:: bash
628+
629+
r5900-1-gsa(config)# cloud-inits cloud-init test-cloud-init config user-data
630+
(<Cloud-init user data>):
631+
[Multiline mode, exit with ctrl-D.]
632+
> #cloud-config
633+
> write_files:
634+
> - path: /tmp/custom-config.sh
635+
> permissions: 0755
636+
> owner: root:root
637+
> content: "#!/bin/bash\n\necho \"Hello World\" >> /var/tmp/cloud-init-output1\n\n# Wait for MCPD to be up before running tmsh commands\nsource /usr/lib/bigstart/bigip-ready-functions\nwait_bigip_ready\n\n# Begin BIG-IP configuration\ntmsh modify sys global-settings gui-setup disabled\ntmsh modify sys global-settings gui-security-banner-text \"Configured now with cloud-init\"\n\ntmsh save /sys config\necho \"Hello World END\" >> /var/tmp/cloud-init-output2\n"
638+
> runcmd:
639+
> - /tmp/custom-config.sh &
640+
> chpasswd:
641+
> list: "root:********\nadmin:********\n"
642+
> expire: False
643+
>
644+
r5900-1-gsa(config)#
645+
646+
Once the named cloud-init object has been created you can then reference it within the tenant configuration, and it will be executed upon boot.
647+
648+
.. code-block:: bash
649+
650+
r5900-1-gsa(config)# tenants tenant tenant1 config cloud-init test-cloud-init
651+
r5900-1-gsa(config-tenant-tenant1)# commit
652+
653+
654+
612655
613656
Tenant Deployment via webUI
614657
---------------------------

0 commit comments

Comments
 (0)