OpenStack Client - Revision history

Jrdundas: /* Install the openstack client */

2026-05-05T15:27:49Z

Install the openstack client

← Older revision		Revision as of 15:27, 5 May 2026
Line 26:		Line 26:

	<tab name="pip">		<tab name="pip">
	This will get you the latest version of the client		This will get you the latest version of the client. You might wish to use a python version/environment manager like pyenv.
	{{Code		{{Code
	\|lang="bash"		\|lang="bash"

Jrdundas: /* Install the openstack client */

2026-05-05T15:26:53Z

Install the openstack client

← Older revision		Revision as of 15:26, 5 May 2026
Line 4:		Line 4:
	<tabs>		<tabs>
	<tab name="Fedora/RedHat Linux">		<tab name="Fedora/RedHat Linux">
	You can install the client ~~form~~ you package manager		You can install the client from you package manager, but the pip install is probably more up to date!
	{{Code		{{Code
	\|lang="bash"		\|lang="bash"
	\|contents=		\|contents=
	sudo dnf install python-openstackclient~~-doc~~.noarch		sudo dnf install python-openstackclient.noarch
	# test the installation		# test the installation
	openstack --version		openstack --version
Line 67:		Line 67:

	A list of the main plugins is available in [https://docs.openstack.org/python-openstackclient/latest/cli/plugin-commands/index.html openstack documentation client page].		A list of the main plugins is available in [https://docs.openstack.org/python-openstackclient/latest/cli/plugin-commands/index.html openstack documentation client page].


	==Configure the client==		==Configure the client==

Poq: /* Use Application Credential */

2026-04-29T23:52:21Z

Use Application Credential

← Older revision		Revision as of 23:52, 29 April 2026
Line 107:		Line 107:


	But if you already have credentials in place, only change the <code>OpenStack</code> key with <code><cred reference></code> and copy that whole block in your ~~current~~ <code>~/.config/openstack/cloud.yaml</code> file.		But if you already have credentials in place, only change the <code>OpenStack</code> key with <code><cred reference></code> and copy that whole block in your <code>~/.config/openstack/cloud.yaml</code> file.

Poq at 23:50, 29 April 2026

2026-04-29T23:50:05Z

← Older revision		Revision as of 23:50, 29 April 2026
Line 78:		Line 78:
	On the Juno's web page left side menu, '''click Identity >> Application Credentials'''''Italic text'', then click '''Create Application Credentials'''''Italic text''. This pops up a Creation window. You need to set a Name for the credential, all other entries are optional but we also recommend setting an expiration date for the credential. Note that the credentials are always linked to a ''user'' and cannot be a ''project'' credential without any owner.		On the Juno's web page left side menu, '''click Identity >> Application Credentials'''''Italic text'', then click '''Create Application Credentials'''''Italic text''. This pops up a Creation window. You need to set a Name for the credential, all other entries are optional but we also recommend setting an expiration date for the credential. Note that the credentials are always linked to a ''user'' and cannot be a ''project'' credential without any owner.

	Once you are happy with the Name, click '''Create Application Credential'''''Italic text''. This pups up a window with the credential ID and its secret. You can copy that information, but downloading the <~~ref~~>clouds.yaml</~~ref~~> file is more convenient.		Once you are happy with the Name, click '''Create Application Credential'''''Italic text''. This pups up a window with the credential ID and its secret. You can copy that information, but downloading the <code>clouds.yaml</code> file is more convenient.

	That file will need some minimal modification to be usable.		That file will need some minimal modification to be usable.
Line 97:		Line 97:
	</syntaxhighlight>		</syntaxhighlight>

	You need to replace the <~~ref~~>OpenStack</~~ref~~> key with a unique name <~~ref~~><cred reference></~~ref~~>; it could be the project name or the credential name, you pick.		You need to replace the <code>OpenStack</code> key with a unique name <code><cred reference></code>; it could be the project name or the credential name, you pick.

	The first time you create the credentials, you will need to copy the full file here:		The first time you create the credentials, you will need to copy the full file here:

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	mkdir ~/.config/openstack/		mkdir ~/.config/openstack/
Line 105:		Line 106:
	</syntaxhighlight>		</syntaxhighlight>

	But if you already have credential in place, only change the <ref>OpenStack</ref> key with <ref><cred reference></ref> and copy that whole block in your current <ref>~/.config/openstack/cloud.yaml</ref> file.

			But if you already have credentials in place, only change the <code>OpenStack</code> key with <code><cred reference></code> and copy that whole block in your current <code>~/.config/openstack/cloud.yaml</code> file.

	Then the ~~credential~~ can be ~~use~~ by setting the <~~ref~~>OS_CLOUD</~~ref~~> env var in your session or by using the <~~ref~~>--os-cloud</~~ref~~> client flag. For example to list all the ~~network~~ in your project:

			Then the credentials can be used by setting the <code>OS_CLOUD</code> env var in your session or by using the <code>--os-cloud</code> client flag. For example to list all the networks in your project:

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 115:		Line 118:
	# or		# or
	openstack --os-cloud <cred reference> network list		openstack --os-cloud <cred reference> network list
	</syntaxhighlight>		</syntaxhighlight>


	===Use your Username and Password===		===Use your Username and Password===
Line 122:		Line 126:
	[[File:Get openstack rc file.gif\|caption\|frame\|none\| the RC file from the Juno website]]		[[File:Get openstack rc file.gif\|caption\|frame\|none\| the RC file from the Juno website]]

	~~Lets~~ say that we have saved the files here <code> $HOME/id/myproject-openrc.sh.</code>		Let’s say that we have saved the files here <code> $HOME/id/myproject-openrc.sh.</code>

	You can test the connection by listing all the images made available on the platform that can be used out of the box to start VMs.		You can test the connection by listing all the images made available on the platform that can be used out of the box to start VMs.

Poq at 19:19, 29 April 2026

2026-04-29T19:19:36Z

← Older revision		Revision as of 19:19, 29 April 2026
Line 124:		Line 124:
	Lets say that we have saved the files here <code> $HOME/id/myproject-openrc.sh.</code>		Lets say that we have saved the files here <code> $HOME/id/myproject-openrc.sh.</code>

	~~== Test the connection ==~~		You can test the connection by listing all the images made available on the platform that can be used out of the box to start VMs.

	~~We will~~ test the connection by listing all the images made available on the platform that can be used out of the box to start VMs.

	<syntaxhighlight lang="bash" line>		<syntaxhighlight lang="bash" line>
	$ source $HOME/id/myproject-openrc.sh		$ source $HOME/id/myproject-openrc.sh
	Please enter your OpenStack Password for project po-~~test~~ as user ~~poq~~:		Please enter your OpenStack Password for project <my-project> as user <my user name>:
	# Use the same password that you used to connect to the [https://juno.calculquebec.ca/ Juno web page].		# Use the same password that you used to connect to the [https://juno.calculquebec.ca/ Juno web page].
	# you can now create the credentials		# you can now create the credentials

Poq at 19:18, 29 April 2026

2026-04-29T19:18:05Z

← Older revision		Revision as of 19:18, 29 April 2026
Line 117:		Line 117:
	</syntaxhighlight>		</syntaxhighlight>

	===~~Get the client rc file~~===		===Use your Username and Password===

Poq: /* Use Application Credential */

2026-04-29T19:16:40Z

Use Application Credential

@@ Line 76: / Line 76: @@
 While you can use your username and password to configure your OpenStack client (see the Get the client rc file below), it is recommended to use application credential to connect to the platform.
-On the Juno's web page left side menu, click *_Identity >> Application Credentials_*, then click *_Create Application Credentials_*. This pops up a Creation window, you need to set a Name for Credential. All other entries are optional but we recomand also seting an expiration date for the credential. Not that the credential are always linked to a user and not _project_ credential that are not linked to an account can be created.
+On the Juno's web page left side menu, '''click Identity >> Application Credentials'''''Italic text'', then click '''Create Application Credentials'''''Italic text''. This pops up a Creation window. You need to set a Name for the credential, all other entries are optional but we also recommend setting an expiration date for the credential. Note that the credentials are always linked to a ''user'' and cannot be a ''project'' credential without any owner.
-Once you are happy with the Name, click _*Create Application Credential*_
+Once you are happy with the Name, click '''Create Application Credential'''''Italic text''. This pups up a window with the credential ID and its secret. You can copy that information, but downloading the <ref>clouds.yaml</ref> file is more convenient.
 ===Get the client rc file===

Poq at 18:18, 29 April 2026

2026-04-29T18:18:36Z

@@ Line 68: / Line 68: @@
 A list of the main plugins is available in [https://docs.openstack.org/python-openstackclient/latest/cli/plugin-commands/index.html openstack documentation client page].
-Once the client is install you need to set login credentials. You can get these credentials by connecting to the [https://juno.calculquebec.ca/ Juno web page]. Select the right project to store your data and download the RC file:
+==Configure the client==
 [[File:Get openstack rc file.gif|caption|frame|none| the RC file from the Juno website]]

Poq: /* Installing Missing Plugins with pip */

2025-07-24T14:50:55Z

Installing Missing Plugins with pip

← Older revision		Revision as of 14:50, 24 July 2025
Line 59:		Line 59:


	===Installing Missing Plugins ~~with pip~~===		===Installing Missing Plugins===

	Depending on the procedure that was used to install the OpenStask client, some plugin could be missing. They can be added with pip, for example the <code>share</code> subcommand is part of the Manilla plugin:		Depending on the procedure that was used to install the OpenStask client, some plugin could be missing. They can be added with pip, for example the <code>share</code> subcommand is part of the Manilla plugin:

Poq at 14:30, 24 July 2025

2025-07-24T14:30:47Z

← Older revision		Revision as of 14:30, 24 July 2025
Line 58:		Line 58:
	</tabs>		</tabs>


			===Installing Missing Plugins with pip===

			Depending on the procedure that was used to install the OpenStask client, some plugin could be missing. They can be added with pip, for example the <code>share</code> subcommand is part of the Manilla plugin:
			<syntaxhighlight lang="bash" line>
			pip install python-manilaclient
			</syntaxhighlight>

			A list of the main plugins is available in [https://docs.openstack.org/python-openstackclient/latest/cli/plugin-commands/index.html openstack documentation client page].

	==Get the client rc file==		==Get the client rc file==