OpenStack-komentorivityökalun asentaminen paketinhallintatyökaluilla

Tässä artikkelissa kuvataan, kuinka OpenStackin komentorivityökalut asennetaan Ubuntu-, Red Hat- ja OS X -pohjaisiin järjestelmiin, jotta OpenStackin eri ominaisuuksia voidaan hallita tehokkaasti. Asennusohjeet perustuvat Pythonin pip-pakettiin. Kun pip on asennettu, vaiheet ovat samat kaikissa järjestelmissä.

Info

Jos sinulla ei ole pääkäyttäjä-/järjestelmänvalvojan oikeuksia järjestelmään, jossa haluat käyttää komentoriviasiakasohjelmia, katso ohjeet virtuaaliympäristöistä.

Asentaminen Windowsiin on myös mahdollista, mutta se ei kuulu tämän oppaan piiriin. Rackspace ylläpitää ohjetta python-novaclientin asentamisesta Windowsiin.

Suosittelemme tutustumaan ensin Poudan selainkäyttöliittymään ja keskeisiin käsitteisiin.

Yleiskatsaus OpenStackin komentorivityökaluihin

On olemassa yleinen komentorivityökalu nimeltä "openstack", jota voidaan käyttää useimpien OpenStackin toimintojen hallintaan. Lisäksi on olemassa yksittäisiä työkaluja vain tiettyjen OpenStackin toimintojen hallintaan, kuten "neutron" verkkojen hallintaan ja "glance" virtuaalikonelevykuvien hallintaan. Useimmissa tapauksissa tulisi käyttää yleistä openstack-työkalua. OpenStack-projekti on merkinnyt muut työkalut vanhentuneiksi, ja niitä tarvitaan yleensä vain, jos sinulla on niistä riippuvaisia skriptejä tai sinun täytyy suorittaa tiettyjä ylläpitokomentoja.

Tool name	Package name	Used for
openstack	python-openstackclient	Koko OpenStackin hallinta
nova	python-novaclient	Virtuaalikoneiden hallinta sekä joitakin rajattuja toimintoja esimerkiksi taltioiden ja levykuvien hallintaan.
neutron	python-neutronclient	Virtuaaliverkkojen ja reitittimien hallinta.
glance	python-glanceclient	Virtuaalikonelevykuvien hallinta.
cinder	python-cinderclient	Taltioiden hallinta, jotka voidaan liittää virtuaalikoneisiin.
swift	python-swiftclient	Objektien hallinta Swift API:n avulla

Valmistelut

Varsinaisten komentorivityökalujen asennusta varten asennamme pipin ja Pythonin kehityspaketit.

Info

Oletamme tässä, että Python on jo asennettu. Tämä on todennäköisesti jo tilanne, jos käytät jotakin käyttöjärjestelmistä, joille meillä on tässä ohjeet.

Selvitä, onko Python asennettu ja mikä sen versio on:

python --version

Tarvitset Python 3:n tai uudemman, jotta voit asentaa komentorivin asiakastyökalut. Jos käytät edes suhteellisen tuoretta versiota käyttöjärjestelmästäsi, tämän ei pitäisi olla ongelma. Jos kuitenkin käytössäsi on Red Hat -pohjainen järjestelmä, joka on vanhempi kuin versio 7, et voi asentaa Python 3:a normaalilla tavalla. Emme tue RHEL/CentOS 7:ää vanhempia versioita.

Jos Python ei jostain syystä ole asennettuna, asenna se ensin.

Valmistelut: Ubuntu-pohjaiset järjestelmät

Jos käytössä on Ubuntu 16.04 tai uudempi:

sudo apt install python3-pip python3-dev

Versioille, jotka ovat vanhempia kuin 16.04:

sudo apt-get install python3-pip python3-dev

Valmistelut: Red Hat -pohjaiset järjestelmät

Jos käytössä on versio 7 tai uudempi:

sudo yum install python3-pip python3-devel

Valmistelut: OS X -järjestelmät

Nykyaikainen macOS ei sisällä Pythonia oletuksena. Helpoin tapa asentaa Python 3 (joka sisältää myös pipin) on käyttää Homebrew'ta:

brew install python3

Vaihtoehtoisesti voit ladata ja suorittaa virallisen asennustyökalun osoitteesta python.org.

Asennuksen jälkeen pip3 on käytettävissä alla olevia vaiheita varten.

openstack-työkalun asentaminen (kaikki käyttöjärjestelmät)

Tästä eteenpäin asennusohjeet ovat samat kaikille käyttöjärjestelmille.

Valinnainen: asennus Python-virtuaaliympäristöön

Jos käytät tietokoneellasi myös muita Python-ohjelmistoja OpenStackin komentorivityökalujen lisäksi, suosittelemme Pythonin virtuaaliympäristöjen käyttöä. Pythonin virtuaaliympäristöt ovat tapa luoda eristetty joukko Python-paketteja, jotka ovat käytettävissä vain kyseisessä virtuaaliympäristössä. Ne ovat erittäin käteviä Python-asennuksen pitämiseksi siistinä ja hallittavana. Tarvitset niitä myös, jos haluat asentaa komentorivin asiakastyökalut tietokoneelle, johon sinulla ei ole pääkäyttäjäoikeuksia. Siinä tapauksessa järjestelmänvalvojasi täytyy asentaa Python, pip ja Pythonin virtualenv-paketti puolestasi. Lisätietoja virtuaaliympäristöistä on oppaassa The Hitchhiker's Guide to Python.

Tässä annamme perusohjeet yksinkertaisen virtuaaliympäristön luomiseen asiakastyökalujen asentamista varten. Jos et halua käyttää virtuaaliympäristöjä, voit ohittaa nämä vaiheet ja siirtyä suoraan pipillä tehtäviin asennusohjeisiin.

Asenna ensin python3-venv-paketti. Ubuntussa:

sudo apt install python3-venv

Huomaa, että Red Hat -pohjaisissa järjestelmissä ei tarvitse asentaa erillistä pakettia.

Luo hakemisto virtuaaliympäristöillesi. Annamme sille tietyn nimen, mutta voit kutsua sitä myös jollakin muulla nimellä:

mkdir python_virtualenvs

Siirry hakemistoon ja luo uusi virtuaaliympäristö:

cd python_virtualenvs
python3 -m venv osclient

Tämä luo uuden hakemiston nimeltä "osclient" "python_virtualenvs"-hakemistoon. Tämä hakemisto sisältää kaiken, mitä asennat virtuaaliympäristöön. Se sisältää myös skriptin ympäristön aktivointia varten, joka sinun täytyy suorittaa seuraavaksi:

source osclient/bin/activate

Aktivoinnin jälkeen seuraavat Python- tai pip-komennot suoritetaan virtuaaliympäristön kontekstissa. Jos jatkat nyt alla olevien asennusohjeiden mukaan, kaikki paketit asennetaan juuri luomaasi virtuaaliympäristöön. Tiedät, että "osclient"-virtuaaliympäristö on aktivoitu, kun näet tekstin "(osclient)" ennen komentokehotetta käyttämässäsi shellissä. Jos asennat komentoriviasiakasohjelmat virtuaaliympäristöön, ne ovat käytettävissä vain kyseisessä virtuaaliympäristössä.

Asennuksen jälkeen voit poistaa virtuaaliympäristön käytöstä kirjoittamalla yksinkertaisesti:

deactivate

Huomaa, että tämän jälkeen myöskään asentamasi komentorivityökalut eivät ole käytettävissä, ennen kuin aktivoit virtuaaliympäristön uudelleen.

Asiakastyökalujen asentaminen pipillä

OpenStack tarjoaa joukon Python-työkaluja eri toimintojensa hallintaan. Jokaisella OpenStackin osakomponentilla on oma työkalunsa. Se tarjoaa myös yhteisen jaetun työkalun python-openstackclient. Helpoin tapa asentaa useimmat komentorivityökalut on asentaa python-openstackclient. Sen pitäisi vetää mukanaan useita muita asiakasohjelmia riippuvuuksina. Jos tarvitsemasi työkalu puuttuu edelleen python-openstackclientin asentamisen jälkeen, katso tämän sivun alussa olevasta taulukosta luettelo asennettavista paketeista.

Info

Jos seurasit ohjeita virtuaaliympäristön luomiseksi, poista "sudo" alla olevien komentojen alusta. Koska asennat omaan virtuaaliympäristöösi, et halua suorittaa komentoja pääkäyttäjänä.

Info

Uudemmissa Linux-jakeluissa (esim. Ubuntu 23.04+, Debian 12+) pip saattaa kieltäytyä asentamasta paketteja järjestelmänlaajuisesti virheellä externally-managed-environment. Jos kohtaat tämän, käytä joko yllä olevia virtuaaliympäristöohjeita tai asenna työkalut eristettyyn ympäristöön pipx:llä, esimerkiksi pipx install python-openstackclient.

Asenna python-openstackclient pipillä:

sudo pip3 install python-openstackclient

Info

PyPI:n uusin julkaisu ei ole aina yhteensopiva cPoudassa/ePoudassa tällä hetkellä käytössä olevan OpenStack-version kanssa. Katso suositellut asiakasversiot, joiden tiedetään toimivan, ja asenna tietty versio esimerkiksi komennolla sudo pip3 install python-openstackclient==5.8.1.

Jos haluat asentaa myös kaikki tämän sivun alussa luetellut palvelukohtaiset työkalut:

sudo pip3 install python-keystoneclient python-novaclient python-glanceclient python-neutronclient

Tietokoneesi kokoonpanosta riippuen joitakin riippuvuuksia saattaa puuttua. Virheilmoitus ImportError: No module named <module> voidaan yleensä korjata asentamalla puuttuva moduuli pipillä ja toistamalla sitten edellinen epäonnistunut komento. Joissakin asennuksen aikaisissa virheissä setuptoolsin tai pipin päivittäminen voi auttaa. Päivitä paketti:

sudo pip3 install -U python_module_to_be_upgraded

Määritä pääteympäristösi OpenStackia varten

Ympäristömuuttujat täytyy asettaa ennen kuin voit käyttää asiakasohjelmaa. Voit asettaa ne OpenStackin selainkäyttöliittymässä tarjotun skriptin avulla. Voit ladata tämän skriptin seuraavasta URL-osoitteesta kirjautumisen jälkeen:

https://pouta.csc.fi/dashboard/project/api_access/

Ladataksesi tämän selainkäyttöliittymässä siirry osioon API Access ja paina Download OpenStack RC File v3.

RC-tiedoston esimerkki

Kun olet saanut openrc-skriptin selainkäyttöliittymästä, voit lisätä ympäristömuuttujat:

source <project_name_here>-openrc.sh

Sinua pyydetään kirjoittamaan salasana. Käytä CSC- käyttäjätunnuksesi salasanaa, koska komentorivikäyttöliittymä ei vielä tue linkitettyjen tunnusten, kuten Hakan tai Virtun, käyttöä. Tämän jälkeen nykyisessä pääteistunnossa ovat oikeat ympäristömuuttujat komentorivityökalujen käyttöä varten. Tämä täytyy tehdä uudelleen, jos avaat uuden päätteen.

Voit varmistaa, että kaikki toimii, listaamalla instanssisi:

openstack server list