Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

Odkaz na výstup diff

Obě strany předchozí revize Předchozí verze
Následující verze		 Předchozí verze
cs:navody:ltp:start [09.07.2020 13:52] – stará verze byla obnovena (27.08.2019 16:33) danecek_cesnet.czcs:navody:ltp:start [23.06.2022 14:45] (aktuální) – danecek_cesnet.cz
Řádek 1: Řádek 1:
-~~TOC 2-3~~ +~~TOC 2-4~~ 
 ====== LTP ====== ====== LTP ======
 Na této stránce naleznete návod na využívání služby LTP provozované sdružením CESNET. Tato služba je určena pro dlouhodobé uchovávání dat trvalé hodnoty. Na této stránce naleznete návod na využívání služby LTP provozované sdružením CESNET. Tato služba je určena pro dlouhodobé uchovávání dat trvalé hodnoty.
Řádek 60: Řádek 60:
  
 =====Ukládání archivních balíčků a jejich správa===== =====Ukládání archivních balíčků a jejich správa=====
-Pro ukládání archivních balíčků je možné využít webové prostředí na adrese https://ltp.cesnet.cz/. Do něj se registrovaní uživatelé přihlásí svou institucionální identitou.+Pro ukládání archivních balíčků je možné využít webové prostředí na adrese https://ltp.cesnet.cz/. Registrovaní uživatelé se přihlásí svou institucionální identitou. 
 +<note important>Pro registraci ke službě LTP je nejdříve nutné se obrátit na [[du-support@cesnet.cz|uživatelskou podporu]] Datových úložišť.</note>
  
-{{:cs:navody:ltp:ltp1.png?700|}}+{{ :cs:navody:ltp: n_ltp1.png?700 |}}
  
 Po přihlášení do služby LTP můžete v levém horním rohu vybrat příslušný skupinový kontext (pokud jste členem jen jedné skupiny, budete mít na výběr jen jednu možnost). Skupinovým kontextem se rozumí skupina vytvořená a spravovaná v systému pro správu uživatelů, jejímž jste členem. Tato skupina využívající službu LTP CESNET je správcem všech dat, které do služby nahrají členové příslušné skupiny. Její členové mohou do kontextu přidávat nové balíčky, zobrazovat detaily archivních balíčků, auditní zprávy a provádět updaty. Po přihlášení do služby LTP můžete v levém horním rohu vybrat příslušný skupinový kontext (pokud jste členem jen jedné skupiny, budete mít na výběr jen jednu možnost). Skupinovým kontextem se rozumí skupina vytvořená a spravovaná v systému pro správu uživatelů, jejímž jste členem. Tato skupina využívající službu LTP CESNET je správcem všech dat, které do služby nahrají členové příslušné skupiny. Její členové mohou do kontextu přidávat nové balíčky, zobrazovat detaily archivních balíčků, auditní zprávy a provádět updaty.
Řádek 70: Řádek 71:
 Odhlášení ze služby LTP CESNET je možné provést po kliknutí na ikonku (zelená) v pravém horním rohu a kliknutí na tlačítko **Logout**. Odhlášení ze služby LTP CESNET je možné provést po kliknutí na ikonku (zelená) v pravém horním rohu a kliknutí na tlačítko **Logout**.
  
-{{:cs:navody:ltp:ltp2.png?700|}}+{{ :cs:navody:ltp:n_ltp2.png?700 |}}
  
 === Nahrávání/vytvoření archivního balíčku === === Nahrávání/vytvoření archivního balíčku ===
Řádek 79: Řádek 80:
 */ */
  
-Pro nahrání archivního balíčku je nezbytné vyplnit jeho název **File name**. Následně můžeme přidat uživatelská metadata **Package metadata**. Zde můžeme využít buď ručního vložení metadat ve fromátu json, případně můžeme nahrát metadata pomocí existujícího json souboru, nebo vyplnit identifikátory zcela ručně. Nakonec vybereme z lokálního disku příslušný zabalený balíček ve formátu *.zip a klikneme na tlačítko **Store**.+Pro nahrání archivního balíčku je nezbytné (1) vybrat kskupinový kontext a (2) vyplnit název záznamu **Package name**. Následně můžeme přidat (3) uživatelská metadata **Package metadata**. Zde můžeme využít buď ručního (4) vložení metadat, případně můžeme nahrát metadata pomocí existujícího json souboru. Nakonec vytvoříme nový záznam (5).
  
-<note warning>Pokud kontroly balíčku po vložení do systému neproběhnou správně, bude balíček označen jako nevalidní a po nějaké době bude automaticky odstraněn. Je tedy zcela zásadní po vkládání balíčku vždy zkontrolovat, že je balíček systémem korektně přijat. To je popsáno v auditních zprávách a ve stručné podobě také jako status balíčku.</note>+{{ :cs:navody:ltp:n_ltp3.png?700 |}}
  
-{{:cs:navody:ltp:ltp3.png?700|}}+Po vytvoření nového záznamu se nám zobrazí stránka pro upload souborů. Zde můžete buď archivní balíček vybrat z disku, případně přetáhnout do okna prohlížeče. 
 + 
 +{{ :cs:navody:ltp:n_ltp4.png?700 |}} 
 + 
 +Jakmile vyberete soubor, můžete kliknout na tlačítko **Upload file**. 
 + 
 +{{ :cs:navody:ltp:n_ltp5.png?700 |}} 
 + 
 +Po nahrání archivního balíčku se v přehledovém menu zobrazí váš záznam s šedou hlavičkou. Tento stav indikuje, že záznam byl v pořádku vytvořen a soubor byl uložen. Jakmile proběhnou kontroly archivního balíčku (validace balíčku), tak bude hlavička záznamu zelená (podobně jako u záznamu vpravo). 
 + 
 +{{ :cs:navody:ltp:n_ltp6.png?700 |}} 
 + 
 +<note warning>Pokud kontroly balíčku po vložení do systému neproběhnou správně, bude balíček označen jako nevalidní a po nějaké době bude automaticky odstraněn. Je tedy zcela zásadní po vkládání balíčku vždy zkontrolovat, že je balíček systémem korektně přijat. To je popsáno v auditních zprávách a ve stručné podobě také jako status balíčku.</note>
  
-Po kliknutí na tlačítko **Store to LTP** dojde k nahrání archivního balíčku, o jehož průběhu vás bude informovat progress bar 
-{{:cs:navody:ltp:ltp33.png?700|}} 
  
 === Správa archivního balíčku === === Správa archivního balíčku ===
Řádek 92: Řádek 103:
 V levém menu klikneme na tlačítko **Archives**, čímž dojde k zobrazení přehledu archivních balíčků. Každý balíček je jednoznačně identifikován svým **ID**. Dále je u každého balíčku uveden **Create date**, **Version** - v případě updatu dochází k verzování balíčků, **Status** - [[#stavove_kody|popis stavů balíčku]] a proklik na **detailní informace** k danému balíčku. V levém menu klikneme na tlačítko **Archives**, čímž dojde k zobrazení přehledu archivních balíčků. Každý balíček je jednoznačně identifikován svým **ID**. Dále je u každého balíčku uveden **Create date**, **Version** - v případě updatu dochází k verzování balíčků, **Status** - [[#stavove_kody|popis stavů balíčku]] a proklik na **detailní informace** k danému balíčku.
  
-{{:cs:navody:ltp:ltp4.png?700|}}+{{ :cs:navody:ltp:ltp65.png?700 |}}
  
 === Detaily balíčku  === === Detaily balíčku  ===
  
-Po kliknutí na **detail balíčku** se zobrazí přehled dostupných informací o balíčku (ID, Create date, Version, Status, Metadata, Archive Package content, ...). Na zobrazené stránce je možné balíček stáhnout - tlačítko **Download** připadně provést jeho editaci - tlačítko **Edit**. Níže pak nalezneme výpis auditních zpráv k příslušnému balíčku, například kontrola kontrolních součtů, informace o stažení atp.+Po kliknutí na **detail balíčku** se zobrazí přehled dostupných informací o balíčku (ID, Create date, Version, Status, Metadata, Archive Package content, ...). Na zobrazené stránce je možné balíček stáhnout - tlačítko **Prepare download**, provést jeho editaci - tlačítko **Edit archive**, případně vynutit jeho validaci - tlačítko **Enforce validation** (kontrola kontrolního součtu). Vpravo pak nalezneme výpis auditních zpráv k příslušnému balíčku, například kontrola kontrolních součtů, informace o stažení atp.
  
-{{:cs:navody:ltp:ltp5.png?700|}}+{{ :cs:navody:ltp:n_ltp7.png?700 |}}
  
 === Stažení balíčku === === Stažení balíčku ===
  
-Při prvním kliknutí na tlačítko **Download** musí nejdříve systém připravit balíček pro stažení. Tato příprava zahrnuje jeho vytažení z archivu a kontrolu kontrolního součtu. V auditních záznamech se objeví v následujícím pořadí tři záznamy. \\ +Neprve musíme přejít na deatil balíčku, jehož obsah chceme stáhnout. Následně klikneme na tlačítko (1) **Prepare download**. Archivní balíček musí nejdříve systém připravit pro stažení. Tato příprava zahrnuje jeho vytažení z archivu a kontrolu kontrolního součtu. 
-1. Operation: Content download from LTP requested - toto je vyvoláno po prvním požadavkem na stažení \\ + 
-2. Operation: Content checksum successfully verified - kontrola kontrolního součtu - provede se na pozadí \\ +Jakmile jsou kontroly dokončeny objeví se tlačítko (2) **Download here**, čímž dojde ke stažení balíčku. 
-3. Operation: Content downloaded from LTP - balíček byl úspěšně stažen z LTP úložiště - provede se automaticky po reloadu stránky, pokud je balíček připraven ke stažení+ 
 +{{ :cs:navody:ltp:n_ltp75.png?700 |}}
  
 <note important>Při stahování objemnějších balíčků může kontrola několik minut trvat.</note> <note important>Při stahování objemnějších balíčků může kontrola několik minut trvat.</note>
Řádek 111: Řádek 123:
 === Úpravy metadat === === Úpravy metadat ===
  
-Při kliknutí na tlačítko **Update** se zobrazí formulář podobný tomu, který jsme použili pro vytvoření/uložení archivního balíčku. Zde je možné změnit metadata balíčku včetně updatu dat samotného balíčku. Po dokončení editace stačí kliknout na tlačítko **Store** a dojde k uložení balíčku. Následně bude balíček v poli **Version** označen vyšším číslem než předchozí verze.+Při kliknutí na tlačítko **Edit Archive** se zobrazí formulář podobný tomu, který jsme použili pro vytvoření/uložení archivního balíčku. Zde je možné změnit metadata balíčku. Po dokončení editace stačí kliknout na tlačítko **Save Changes** a dojde k uložení balíčku. Následně bude balíček v poli **Version** označen vyšším číslem než předchozí verze.
  
-{{:cs:navody:ltp:ltp6.png?700|}}+{{ :cs:navody:ltp:n_ltp8.png?700 |}}
  
 === Správa auditních zpráv === === Správa auditních zpráv ===
Řádek 119: Řádek 131:
 Při kliknutí na tlačítko **Audits** v levém menu si můžete zobrazit všechny auditní zprávy pro všechny balíčky uložené v daném skupinovém kontextu. Nejčerstvější auditní záznamy si můžete rovněž prohlédnout, pokud kliknete na ikonku zvonečku v pravé horní části stránky. Při kliknutí na tlačítko **Audits** v levém menu si můžete zobrazit všechny auditní zprávy pro všechny balíčky uložené v daném skupinovém kontextu. Nejčerstvější auditní záznamy si můžete rovněž prohlédnout, pokud kliknete na ikonku zvonečku v pravé horní části stránky.
  
-{{:cs:navody:ltp:ltp7.png?700|}}+{{ :cs:navody:ltp:n_ltp9.png?700 |}}
  
 +=== Nastavení notifikací ===
 +Kliknutím na tlačítko **Notifications** (1) v levém menu si můžete nastavit požadované notifikace, například pro případ porušení integrity archivního balíčku.
 +  * **Info** - všechny dostupné notifikace
 +  * **Warning** - dílčí notifikace, například o validaci uploadnutého balíčku apod.
 +  * **Error** - notifikace pro případ selhání periodické kontroly integritz balíčku
 +  * **No notification** - žádné notifikace
 +
 +{{ :cs:navody:ltp:n_ltp95.png?700 |}}
  
 {{anchor:user_profile:}} {{anchor:user_profile:}}
Řádek 126: Řádek 146:
 Pro přístup přes API rozhraní je nezbytné nejdříve získat přístupový API klíč. Klíč má omezenou platnost. Pro přístup přes API rozhraní je nezbytné nejdříve získat přístupový API klíč. Klíč má omezenou platnost.
  
-Přístupový klíč si můžete vygenerovat ve webovém prostředí při kliknutí na tlačítko **User Profile** v levém menu a následně na **Manage Tokens**.+Přístupový klíč si můžete vygenerovat ve webovém prostředí pomocí následujících kroků.
  
-{{:cs:navody:ltp:ltp8.png?700|}}+1. Přihlásit se přes web na https://ltp.cesnet.cz/ \\ 
 +2. Klikněte v levém menu na tlačítko (1) **User Profile**, případně v pravém horním rohu na (2) **vaše jméno**. \\
  
-  - Přihlásit se přes web na https://ltp.cesnet.cz/ \\ +{{ :cs:navody:ltp:n_ltp10.png?700 |}}
-  - Klikněte v levém menu na tlačítko **User Profile** \\ +
-  - Klikněte na talčítko **Manage Tokens** \\ +
-  - Na zobrazené stránce vyplňte název tokenu a klikněte na tlačítko **Save Token** \\ +
-<note important>Token si prosím zkopírujte na bezpečné místo. Z bezpečnostních důvodů jej nebude možné později znovu zobrazit.</note>+
  
-{{:cs:navody:ltp:ltp9.png?700|}}+3. Klikněte na talčítko (1) **Manage Tokens**. Na zobrazené stránce si můžete rovněž vybrat (2) **výchozí skupinový kontext**, který se zobrazí po přihlášení. \\
  
-Pokud provedete obnovení stránky, dojde ke skrytí tokenu. Na zobrazené stránce pak můžete token rovněž revokovat.+{{ :cs:navody:ltp:n_ltp11.png?700 |}}
  
-{{:cs:navody:ltp:ltp10.png?700|}}+4. Na zobrazené stránce vyplňte (1) **název tokenu** a klikněte na tlačítko (2) **Save Token**. Následně si (3) **zkopírujte token** do vašich poznámek. Opětovné zobrazení tokenu již nebude možné. Pokud si přejete některý z existujících tokenů revokovat, můžete použít (4) **tlačítko s křížkem**. \\
  
-<note tip>Doporučujeme **uložit si přístupový token do proměnné shellu**. Následně můžete v curl-příkazech použít tuto proměnnou.</note>+<note important>Token si prosím zkopírujte na bezpečné místo. Z bezpečnostních důvodů jej nebude možné později znovu zobrazit.</note> 
 + 
 +{{ :cs:navody:ltp:n_ltp12.png?700 |}} 
 + 
 + 
 +<note tip>Doporučujeme **uložit si přístupový token do proměnné shellu**. Následně můžete v cli příkazech použít tuto proměnnou.</note>
  
 Uložení uživatelského tokenu do proměnné. Uložení uživatelského tokenu do proměnné.
Řádek 150: Řádek 172:
 d7d6ae316f8cb34ec2561421962a737ce30a95d8</code> d7d6ae316f8cb34ec2561421962a737ce30a95d8</code>
  
-<note important>Příklady kódů pro komunikaci s API využívají program **jq** pro formátování odpovědí API do přehlednější podoby pro živé uživatele. Doporučujeme proto nainstalovat program **jq**.</note>+====Referenční implementace==== 
 +Referenční implementace LTP API je dostupná jako **[[https://github.com/CESNET/ltp-api-client-lib|python knihovna]]**, kde rovněž naleznete **instrukce k instalaci a základní příklady příkazů**. Generovaná dokumentace k LTP je dostupná na **[[https://ltp.cesnet.cz/api/|stránkách služby LTP]]**.  
 + 
 +/* 
 ====Správa uživatelského účtu==== ====Správa uživatelského účtu====
 {{anchor:account_info:}} {{anchor:account_info:}}
Řádek 160: Řádek 186:
 <hidden Příklad odpovědi><code> <hidden Příklad odpovědi><code>
 { {
-  "username": "33c5b2a6e2fdasdasdc2ca76ttgfgdfb0b5@einfra.cesnet.cz", +  "username": "33c5b2a6e2f@einfra.cesnet.cz", 
-  "email": "jan.student@hogwarts.cz",+  "email": "jan.student@cuni.cz",
   "first_name": "Jan",   "first_name": "Jan",
   "last_name": "Student",   "last_name": "Student",
   "groups": [   "groups": [
     {     {
-      "name": "hogwarts", +      "name": "perun.cesnet.cz:VO_ltp_pilot_catchall:ltp_test_group:50b6ea9f-7556f7409917", 
-      "permissions": [ 106 ],+      "permissions": [], 
 +      "is_group_admin": false 
 +    }, 
 +    { 
 +      "name": "perun.cesnet.cz:VO_ltp_pilot_catchall:new-ltp-group:8b0774d5-3cfe5b63ea3e", 
 +      "permissions": [],
       "is_group_admin": false       "is_group_admin": false
     }     }
-  ], +  ]
-  "token": "d7d6ae316f8cb34ec2561421962a737ce30a95d8" +
-}</code></hidden> +
-\\ +
-**GET User Token** - vrátí hodnotu aktuálního uživatelského tokenu. +
-<hidden Příklad dotazu><code>curl --request GET \ +
-  --url https://ltp.cesnet.cz/api/auth/token/ \ +
-  --header "Authorization: Token ${LTP_TOKEN}" \ +
-  --header 'cache-control: no-cache' | jq</code></hidden> +
-<hidden Příklad odpovědi><code>{ +
-  "token": "d7d6ae316f8cb34ec2561421962a737ce30a95d8"+
 } }
 </code></hidden> </code></hidden>
Řádek 459: Řádek 480:
 \\ \\
  
 +/*
 ====Správa auditních zpráv==== ====Správa auditních zpráv====
 **GET LIST All Audit Messages** - vylistuje všechny auditní zprávy ke všem balíčkům uloženým příslušnou skupinou. Celý název příslušné skupiny lze získat pomocí funkce [[#account_info|GET Account info]].   **GET LIST All Audit Messages** - vylistuje všechny auditní zprávy ke všem balíčkům uloženým příslušnou skupinou. Celý název příslušné skupiny lze získat pomocí funkce [[#account_info|GET Account info]].  
Řádek 576: Řádek 598:
 </code></hidden> </code></hidden>
 \\ \\
 +*/
 +/*
 ====Vyhledávání balíčků podle metadat==== ====Vyhledávání balíčků podle metadat====
 Pro prohledávání balíčků, uložených příslušnou skupinou je nezbytné zadat příslušná metadata, podle kterých chceme vyhledávat (níže //user_metadata=milan//). Celý název příslušné skupiny lze získat pomocí funkce [[#account_info|GET Account info]]. Pro prohledávání balíčků, uložených příslušnou skupinou je nezbytné zadat příslušná metadata, podle kterých chceme vyhledávat (níže //user_metadata=milan//). Celý název příslušné skupiny lze získat pomocí funkce [[#account_info|GET Account info]].
Řádek 604: Řádek 628:
 ] ]
 </code></hidden> </code></hidden>
 +*/
 /* /*
 {{anchor:stavove_kody:}} {{anchor:stavove_kody:}}