Programmatic Access and Automation - Revision history

Sia: /* How can I connect to the bwCloud-OS using the OpenStack Python SDK? */

2026-04-27T10:06:47Z

How can I connect to the bwCloud-OS using the OpenStack Python SDK?

← Older revision		Revision as of 10:06, 27 April 2026
Line 148:		Line 148:
	To manage your resources from within Python scripts, you can use the '''OpenStack Python SDK'''.		To manage your resources from within Python scripts, you can use the '''OpenStack Python SDK'''.

	Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see the guide: [[Guide: OpenStack Python SDK – Basic Usage\|OpenStack Python SDK]]):		Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see the guide [[Guide: OpenStack Python SDK – Basic Usage\|OpenStack Python SDK]]):
	<pre>		<pre>
	sudo apt install python3-openstacksdk		sudo apt install python3-openstacksdk

Sia at 10:06, 27 April 2026

2026-04-27T10:06:12Z

← Older revision		Revision as of 10:06, 27 April 2026
Line 148:		Line 148:
	To manage your resources from within Python scripts, you can use the '''OpenStack Python SDK'''.		To manage your resources from within Python scripts, you can use the '''OpenStack Python SDK'''.

	Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see: [[Guide: OpenStack Python SDK – Basic Usage]]):		Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see the guide: [[Guide: OpenStack Python SDK – Basic Usage\|OpenStack Python SDK]]):
	<pre>		<pre>
	sudo apt install python3-openstacksdk		sudo apt install python3-openstacksdk

Sia at 10:05, 27 April 2026

2026-04-27T10:05:00Z

← Older revision		Revision as of 10:05, 27 April 2026
Line 148:		Line 148:
	To manage your resources from within Python scripts, you can use the '''OpenStack Python SDK'''.		To manage your resources from within Python scripts, you can use the '''OpenStack Python SDK'''.

	Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see ~~the guide~~ [[Guide: OpenStack Python SDK – Basic Usage~~\|OpenStack SDK~~]]):		Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see: [[Guide: OpenStack Python SDK – Basic Usage]]):
	<pre>		<pre>
	sudo apt install python3-openstacksdk		sudo apt install python3-openstacksdk

Sia: /* Testing the Connection */

2026-04-26T13:12:02Z

Testing the Connection

← Older revision		Revision as of 13:12, 26 April 2026
Line 165:		Line 165:
	import openstack		import openstack
	conn = openstack.connect(cloud="openstack")		conn = openstack.connect(cloud="openstack")
	token = conn.~~authorize~~()		conn.authorize()
	print(token)		token = conn.session.get_token()
			print("Token:", token)
	</pre>		</pre>

Sia: /* Testing the Connection */

2026-04-26T13:09:50Z

Testing the Connection

← Older revision		Revision as of 13:09, 26 April 2026
Line 165:		Line 165:
	import openstack		import openstack
	conn = openstack.connect(cloud="openstack")		conn = openstack.connect(cloud="openstack")
	conn.authorize()		token = conn.authorize()
			print(token)
	</pre>		</pre>

	This will ~~trigger~~ authentication, confirming that your configuration works correctly~~. Otherwise it would raise an error~~.		This will issue a new authentication token, confirming that your configuration works correctly.

	== How can I perform basic operations with the OpenStack SDK? ==		== How can I perform basic operations with the OpenStack SDK? ==

Sia at 13:04, 26 April 2026

2026-04-26T13:04:51Z

Sia: /* Authentication Methods */

2026-04-26T10:23:33Z

Authentication Methods

← Older revision		Revision as of 10:23, 26 April 2026
Line 156:		Line 156:
	See the section [[Programmatic Access and Automation#How can I create an application credential?\|Create an application credential]].		See the section [[Programmatic Access and Automation#How can I create an application credential?\|Create an application credential]].

	~~In the following~~, we ~~use~~ the <code>clouds.yaml</code> file.		For this purpose, we recommend using the <code>clouds.yaml</code> file.

	=== Testing the Connection ===		=== Testing the Connection ===

Sia at 10:21, 26 April 2026

2026-04-26T10:21:57Z

← Older revision		Revision as of 10:21, 26 April 2026
Line 156:		Line 156:
	See the section [[Programmatic Access and Automation#How can I create an application credential?\|Create an application credential]].		See the section [[Programmatic Access and Automation#How can I create an application credential?\|Create an application credential]].

	In the following, we use the clouds.yaml file.		In the following, we use the <code>clouds.yaml</code> file.

	=== Testing the Connection ===		=== Testing the Connection ===

Sia: /* Authentication Methods */

2026-04-26T10:21:15Z

Authentication Methods

← Older revision		Revision as of 10:21, 26 April 2026
Line 155:		Line 155:
	=== Authentication Methods ===		=== Authentication Methods ===
	See the section [[Programmatic Access and Automation#How can I create an application credential?\|Create an application credential]].		See the section [[Programmatic Access and Automation#How can I create an application credential?\|Create an application credential]].

			In the following, we use the clouds.yaml file.

	=== Testing the Connection ===		=== Testing the Connection ===

Sia: /* How can I perform basic operations with the OpenStack SDK? */

2026-04-26T10:15:37Z

How can I perform basic operations with the OpenStack SDK?

← Older revision		Revision as of 10:15, 26 April 2026
Line 172:		Line 172:

	For common tasks such as managing instances, volumes, and networks, see:		For common tasks such as managing instances, volumes, and networks, see:
	[[Guide: OpenStack Python SDK – Basic Usage]]		[[Guide: OpenStack Python SDK – Basic Usage]].

	= Auto-Deployment =		= Auto-Deployment =

← Older revision		Revision as of 13:04, 26 April 2026
Line 2:		Line 2:
	{{InANutshell\|		{{InANutshell\|
	<li>'''Application Credentials''' enable secure, token-based access to bwCloud-OS — ideal for CLI usage and automation. </li>		<li>'''Application Credentials''' enable secure, token-based access to bwCloud-OS — ideal for CLI usage and automation. </li>
	<li>You can use ~~the~~ credentials with the '''OpenStack CLI''' to manage cloud resources from the command line.</li>		<li>You can use these credentials with the '''OpenStack CLI''' to manage cloud resources from the command line.</li>
	<li>You can also use the credentials with the '''OpenStack Python SDK''' to manage cloud resources programmatically from within Python scripts or applications.</li>		<li>You can also use the credentials with the '''OpenStack Python SDK''' to manage cloud resources programmatically from within Python scripts or applications.</li>
	<li>'''Automation tools''' like '''Ansible''' or '''Terraform''' can be used for efficient deployment and configuration of instances.</li>		<li>'''Automation tools''' like '''Ansible''' or '''Terraform''' can be used for efficient deployment and configuration of instances.</li>
Line 60:		Line 60:

	=== Using the ''clouds.yaml'' file (Recommended for Automation) ===		=== Using the ''clouds.yaml'' file (Recommended for Automation) ===
	A <code>'''''clouds.yaml'''''</code> file provides a convenient way to configure access to OpenStack without exporting many environment variables ~~manually~~.		A <code>'''''clouds.yaml'''''</code> file provides a convenient way to configure access to OpenStack without exporting many environment variables.
	==== Example ''clouds.yaml'' ====		==== Example ''clouds.yaml'' ====

Line 106:		Line 106:
	<span id="OpenStack-CLI"></span>		<span id="OpenStack-CLI"></span>

	To manage your resources from the command line, you can use the '''OpenStack Client''' (<code>openstack</code> ~~CLI~~ tool, ~~based on~~ Python).		To manage your resources from the command line, you can use the '''OpenStack Client''' (<code>openstack</code> command-line tool, implemented in Python).

	Installation of the client depends on your operating system, e.g. for Ubuntu (for other installation methods, see the guide [[Guide: OpenStack CLI – Basic Usage\|OpenStack CLI]]):		Installation of the client depends on your operating system, e.g. for Ubuntu (for other installation methods, see the guide [[Guide: OpenStack CLI – Basic Usage\|OpenStack CLI]]):
Line 125:		Line 125:
	-->=== Testing the Connection ===		-->=== Testing the Connection ===

	Run the following commands ~~inside~~ a terminal:		Run the following commands in a terminal:

	<pre>		<pre>
Line 146:		Line 146:
	<span id="OpenStack-SDK></span>		<span id="OpenStack-SDK></span>

	To manage your resources from ~~inside~~ Python scripts, you can use the '''OpenStack Python SDK'''.		To manage your resources from within Python scripts, you can use the '''OpenStack Python SDK'''.

	Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see the guide [[Guide: OpenStack Python SDK – Basic Usage\|OpenStack SDK]]):		Installation depends on your operating system, e.g. for Ubuntu (for other installation methods, see the guide [[Guide: OpenStack Python SDK – Basic Usage\|OpenStack SDK]]):
Line 190:		Line 190:
	<span id="Ansible-Template"></span>		<span id="Ansible-Template"></span>

	Yes. You can use this [https://github.com/bwCloud/ansible-template Ansible template] ~~for an easier start~~.		Yes. You can use this [https://github.com/bwCloud/ansible-template Ansible template] to get started more easily.