Preskoči na vsebino

Terminalna nadzorna plošča PMIVerse

pmiverse odpre s tipkovnico upravljan pregledovalnik skupnih operativnih orodij: baz, varnostnih kopij, posodobitev repozitorijev, migracij različic Odoo, nameščenih izvajalnih storitev in storitev nadgradnje modulov, testiranja, linta, prevodov in namestitve. Uporablja standardno knjižnico Python, vključno s curses; dodatni paketi Python niso potrebni. Potrebujete Python 3.11 ali novejši s podporo curses in običajen terminal.

Namestitev in zagon

Iz delovne kopije na strežniku namestite ukaze za svoj račun:

/srv/pmiverse/_pmiconfig/scripts/integration/install_cli_shortcuts.sh --user
source ~/.bashrc
pmiverse

Namestilnik poveže pmiverse in restore-db v ~/.local/bin, namesti dopolnjevanje Bash ter v ~/.bashrc doda nastavitve PATH in dopolnjevanja. Nasprotujoče datoteke ukazov ali povezave zavrne. Ponovitev osveži dopolnjevanje brez podvajanja nastavitev lupine. --python /path/to/python v uporabniško nastavitev Bash zapiše drug interpreter plošče. Obstoječe operativne skripte ohranijo lastne vrstice shebang in izvajalno konfiguracijo.

--system poveže ukaze v /usr/local/bin in namesti dopolnjevanje v /etc/bash_completion.d; zahteva ustrezno skrbniško pooblastilo. Za neprivzeti interpreter pri sistemski namestitvi nastavite PMIVERSE_PYTHON v okolju vsakega uporabnika. Namestilnik ne namešča odvisnosti ali storitev.

Pred namestitvijo lahko zaženete neposredno:

PMIVERSE_PYTHON=/path/to/python /srv/pmiverse/_pmiconfig/tools/pmiverse-cli

Oddaljeni zagon uporablja isto delovno kopijo na ciljnem strežniku:

ssh -t demo-host pmiverse

Pripravljalnik ukazov HTML

Zaženite pmiverse --web in v brskalniku odprite izpisani naslov http://127.0.0.1:PORT. Pripravljalnik potrebuje paket Python Markdown, naveden v korenski datoteki zahtev; terminalna plošča še vedno uporablja samo standardno knjižnico Python. Poiščite ukaz, izpolnite obrazec možnosti in izberite Review command. Definicije polj in preverjanje terminalne plošče ustvarijo ukaz z ustreznim navajanjem argumentov za lupino, ki ga kopirate v terminal gostitelja, ki streže stran. Vključuje interpreter, delovno kopijo in izbrano pot --config tega gostitelja, zato nameščena bližnjica pmiverse za izvedbo pripravljenega ukaza ni potrebna.

Seznamska polja sprejmejo po eno dobesedno vrednost na vrstico. Polja z izbirno vrednostjo imajo potrditveno polje za vključitev: vključena prazna vrednost doda zastavico brez argumenta. Urejanje polja počisti predogled ukaza. Navodila pod obrazcem imajo oblikovane naslove, sezname, tabele in bloke kode. Povezave na lokalne dokumente Markdown odprejo oblikovane strani; podprta so sidra naslovov in povezave HTTP/HTTPS. Surovi HTML se filtrira, lokalne povezave pa ne morejo zapustiti zaupanja vrednih repozitorijev.

Registrirani cilji obnove imajo spustni seznam vzdevkov in imen baz; izbira vpiše vzdevek, ki ga pričakuje ukaz. Tudi polja baz, instanc in gostiteljev ponujajo registrirane izbire; pri vseh je na voljo ročni vnos. Odpiranje obrazca s takimi polji prek časovno omejenega nalagalnika terminalne plošče naloži zaupanja vreden izvedljivi inventar Bash, izbran z --config ali PMIVERSE_CONF. Ob manjkajočem ali neveljavnem inventarju ostane ročni vnos. Izbire odražajo registracijo, ne dejanske razpoložljivosti baz; poizvedb PostgreSQL ni.

Izvedba, pozivi, izhod in prekinitev ostanejo v terminalu. Pripravljalnik ne shranjuje vrednosti obrazca. Za skrivnosti uporabite možnosti za datoteke gesel. --read-only --web dovoljuje pripravo, ker ne zaganja operacij.

Strežnik posluša samo na povratnem vmesniku IPv4 ter zavrača tuje gostitelje in izvore zahtev. Ustavite ga s Ctrl-C. Za oddaljeno uporabo posredujte izpisana vrata z ssh -L PORT:127.0.0.1:PORT demo-host, lokalno odprite isti naslov in ukaze prilepite v oddaljeni terminal. Dostop je namenjen zaupanja vrednim uporabnikom gostitelja, ne deljenemu spletnemu gostovanju.

Tipkovnično upravljanje terminala

  • Gor/dol ali j/k izbere ukaz; / filtrira imena, skupine in opise.
  • ? prikaže uporabo, možnosti in primer brez izvajanja skript.
  • o odpre lokalna navodila ukaza s pomikanjem in prehajanjem po straneh.
  • Enter odpre obrazec izbranega ukaza. Gor/dol ali Tab premika med poimenovanimi polji; pomoč izbranega polja se prikaže pod kontrolniki.
  • Preslednica preklopi potrditvena polja. Enter odpre izbire ali ureja dobesedne vrednosti in sezname poti/argumentov. e omogoči ročni vnos baze ali storitve namesto predloga. Vzdevki/imenа baz in predlogi instanc/gostiteljev varnostnih kopij prihajajo iz inventarja, predlogi storitev pa iz nameščenih datotek enot. Predlogi ne poizvedujejo po PostgreSQL in ne zaganjajo storitev.
  • Urejevalniki datotek in map omogočajo brskanje s Tab, premikanje kazalca s puščicami, čiščenje s Ctrl-U, shranitev z Enter in zavrnitev z Escape. Urejevalniki seznamov dodajajo/urejajo posamezne postavke; shranitev prazne postavke jo odstrani. Escape prekliče urejanje; Save list ga uveljavi.
  • F5 ali vedno vidni gumb Review & run preveri obvezna polja in nezdružljive izbire ter prikaže vrednosti in celoten ukaz. Enter izvede pregledano operacijo; Escape vrne obrazec z ohranjenimi vrednostmi. Escape iz obrazca ga zapre brez izvedbe. Tudi ukazi brez možnosti imajo izrecen pregled pred izvedbo.
  • Ukazi tečejo v terminalu z običajnimi pozivi in izhodom. Plošča se po zaključku vrne in izpiše izhodno kodo. Ctrl-C prejme ukaz v ospredju; veljajo njegova pravila prekinitve in okrevanja.
  • d na zahtevo pregleda inventar baz; za osvežitev se vrnite in ponovno pritisnite d.
  • q zapre ploščo. pmiverse --read-only onemogoči vse zagone ukazov, tudi pomoč prek izvajalnega vmesnika; pomoč brez povezave in navodila ostanejo dostopna.

Vsaka vrednost obrazca je dobeseden argument; presledkov v poteh in imenih ni treba navajati za lupino. Testni obrazci imajo ločen seznam Additional pytest arguments: po en argument na postavko, na primer -q in --maxfail=1. Plošča vstavi ločilo izvajalnik/pytest. Razširitve lupine, cevovodi, preusmeritve in zamenjave ukazov se ne vrednotijo. Argumenti se ne shranjujejo. Namesto skrivnosti uporabite možnosti datotek gesel. Obvezni cilji baz se ne izpolnijo iz primerov. Prazna izbirna polja ohranijo privzete nastavitve skript.

Neposredni ukazi in dopolnjevanje

pmiverse --list
pmiverse --describe test-addon
pmiverse --run test-addon -- --help
pmiverse --run test-addon -- --addon-tests /path/addon/tests --database test_demo
pmiverse --run test-repo -- --repo /path/repo --keep-db
pmiverse --run migrate -- --help
pmiverse --run service -- --unit pmisuite18-update.service --action cat

Neposredni --run izrecno izvede ukaz brez potrditve plošče in vrne izhodno kodo programa. Ločilo -- pripada razpošiljevalniku; vse za njim se dobesedno posreduje ukazu. Drugi -- lahko loči argumente pytest, če to zahteva izvajalnik.

V Bash dvakrat pritisnite Tab za pmiverse -- za globalne možnosti. Za pmiverse --run ali pmiverse --describe dopolnjevanje navede imena iz kataloga, za pmiverse --run test-addon -- -- pa možnosti ukaza. Drugi posredovani operandi ponujajo datotečno dopolnjevanje; cilje vnesete izrecno. Dopolnjevanje bere samo katalog, ne nalaga inventarja ali poizveduje po strežniku. Obstoječe dopolnjevanje neposrednih skript ostaja na voljo. PMICONFIG_DIR izbere nestandardno delovno kopijo za dopolnjevanje.

Inventar baz

pmiverse --databases
pmiverse --instance primary --databases
pmiverse --config /path/to/trusted/pmiverse.conf --databases

Privzeta aktivna konfiguracija je $PMIREGISTRY_DIR/config/pmiverse.conf; privzeti PMIREGISTRY_DIR je /srv/pmiverse/_pmiregistry. PMIVERSE_CONF in nato --config jo preglasita. Splošna predloga _pmiconfig ni nadomestni vir.

Konfiguracija je zaupanja vredna izvedljiva koda Bash, naložena v ločenem, časovno omejenem procesu; to ni peskovnik za nezaupanja vredno konfiguracijo. V ploščo se izvozijo samo polja registrov baz in instanc. Manjkajoča ali neveljavna konfiguracija ne prepreči brskanja po ukazih.

Pregled izbere instance s kratkim imenom lokalnega gostitelja OS, po potrebi omejene z --instance. Če ni ujemanja in --instance ni bil izrecno zahtevan, razvojni in obnovitveni gostitelji primerjajo celoten register baz s privzeto povezavo libpq. Pogled ima oznako local-unregistered; odsotne registrirane baze imajo stanje Not present, kar ne pomeni, da so na gostitelju obvezne. Izrecno zahtevana neujemajoča instanca ostane napaka. Nadomestni pogled ne uporabi nastavitev instance drugega gostitelja.

Vsaka registrirana lokalna instanca se poizveduje ločeno z njenimi polji gostitelja/vrat/uporabnika PostgreSQL. Obstoječe neprazne spremenljivke okolja PG imajo prednost, kot pri razreševalniku kopiranja. Dejanski izbirniki povezave so prikazani. Prazni uporabijo privzete vrednosti libpq, ki lahko izberejo oddaljeno končno točko; plošča ne trdi, da je PostgreSQL lokalen.

Poizvedbe uporabljajo psql brez pozivov za gesla in zagonskih datotek ter časovne omejitve povezave, stavka in celotnega procesa. Uporablja se obstoječa avtentikacija libpq. Ni povišanja pravic ali pisanja v baze. Rezultati ločujejo Present, Missing, Extra, Elsewhere in Unknown. Napaka pomeni Unknown, nikoli Missing. Različice izvirajo iz konfiguracije, ne iz odkrivanja različic Odoo. Sistemske in predložne baze so izključene. JSON --databases ohrani obseg posamezne končne točke.

Izbira inventarja ne vstavi spremenljivk PostgreSQL ali ciljev v operacijo. Preglejte argumente, konfiguracijo in privzete vrednosti samega ukaza. --config se posreduje kot PMIVERSE_CONF; ukazi, ki te nastavitve ne uporabljajo, ohranijo svojo dokumentirano konfiguracijo. --instance omeji samo pregled; možnost operacije --instance podajte za ločilom --.

Operativne meje

Plošča prepusti preverjanje, ključavnice, transakcije in okrevanje obstoječim skriptam. Navedba ukaza ne pomeni nameščenih predpogojev ali primernosti za izbrano bazo. Podpora predogledu in njegovi stranski učinki so dokumentirani po ukazih; plošča ne izmišljuje zastavic za suhi zagon. Ne povišuje pravic, namešča paketov ali namešča predlog.

service upravlja samo izrecno poimenovane, že nameščene enote pmisuite*.service. Podpira status, cat, show, start, stop in restart. Pred nadgradnjo preglejte nameščeno enoto in dopolnitve: cilji baz/modulov izvirajo iz enote, nadgradnja pa lahko ustavi izvajalno storitev in jo pusti ustavljeno. Za vrstni red vzdrževanja preberite navodila storitev. Ponovni zagon izvajalnih storitev po nadgradnji ostaja izrecno dejanje.

Starejši ovoji obnove iz registra ohranijo lastna jamstva; prikaz jim ne doda priprave, zaklepanja ali povratka splošnega orodja obnove.

Lastništvo kataloga

data/commands.csv določa skupna imena, skupine, izvršljive poti, povzetke, poti navodil, primere in možnosti dopolnjevanja. Posodabljajte ga skupaj s CLI. tools/pmiverse_forms.py določa vrste polj, oznake, pomoč, položajne operande, obvezne vrednosti in pravila preverjanja. tools/pmiverse_form_ui.py izrisuje kontrolnike, izbirnike, brskalnike poti in končni pregled. Definicije vzdržujte skladno z dejanskimi pogodbami CLI; neznana možnost brez pregledanih metapodatkov obrazca se zavrne, namesto da bi omogočila prost vnos ukazne vrstice. Neposredni CLI --run ostaja za avtomatizacijo. Rezervirani nedelujoči preverjevalnik politike in izvedbene knjižnice so izključeni. Plošča odkrije tudi izvedljive vrhnje ovoje .sh za kopiranje, obnovo in pridobivanje v _pmiregistry/scripts/ z imeni registry-.

Izbirni _pmiregistry/data/commands.csv lahko doda ukaze konkretne namestitve z isto glavo in potmi glede na ta repozitorij. Podvojena imena in poti zunaj lastniškega repozitorija se zavrnejo. Katalogi so zaupanja vredni vhodi; samo brskanje ne izvede programov. Zasebni inventar, poverilnice, izvajalni izhod in zgodovina operacij ne sodijo v skupne kataloge.