Skip to end of metadata
Go to start of metadata

Adres serwera aktualizacji: http://www.aktualizacje.plusworkflow.pl

Serwer aktualizacji przechowuje paczki aktualizacji i umożliwia ich pobieranie w celu przeprowadzania aktualizacji. Wyróżniamy 2 typy paczek aktualizacji:

  1. projektów klienckich PlusWorkflow
  2. wtyczek systemu PlusWorkflow

Słownik

  • Klient - podmiot uprawniony do pobierania aktualizacji z serwera
  • Środowisko klienta - wyróżnik używany wyłącznie do celów audytowych dzięki któremu wiemu na jakim środowisku klienta dokonano aktualizacji
  • Projekt - projekt kliencki lub wtyczka. Każdy projekt ma co najmniej 1 kanał aktualizacji 
  • Kanał aktualizacji - Faktyczny "koszyk" z aktualizacjami. To w kanale aktualizacji przechowywane są pojedyncze patche. Przykładem zastosowania może być stworzenie kanału releasesnapshot gdzie w release przechowywane są tylko aktualizacje do stabilnych wersji, natomiast w snapshot aktualizacje do wersji rozwojowej. Podobnie w przypadku produkcyjnej i deweloperskiej wersji projektu klienckiego

Klienci

Klient jest podmiotem uprawnionym od pobierania aktualizacji z serwera. Klienci dostępni są z zakładki Klienci.

Tworzenie nowego klienta

Tworzenie nowego klienta ogranicza się do uzupełnienia jego nazwy i identyfikatora:

Edycja klienta

Edycje klienta włączamy poprzez przycisk na liście klientów.

W widoku edycji klienta możemy zdefiniować jego środowiska (klient może mieć wiele środowisk). Najczęściej spotykany zestaw to:

  • PROD
  • TEST
  • DEV

Ponadto mamy dostęp do tokenu API, audytu tego klienta oraz możemy wygenerować plik konfiguracyjny który może być później zaimportowany podczas konfiguracji automatycznych aktualizacji.

Token API używny jest do uwierzytelniania. Powinien on być traktowany jako sekret. Istnieje możliwość wygenerowania nowego tokenu, wtedy stary token wygaśnie natychmiastowo.

Projekty

Zakładka projekty służy do zarządzania projektami. W tym miejscu możemy stworzyć nowe projekty, zarządzać ich kanałami, bezpieczeństwem oraz podglądać dostępne aktualizacje.

Tworzenie projektu

Projekt tworzymy poprzez formularz:

  • Nazwa - unikalna nazwa projektu (znaki A-z 0-9 - _ . ) 

  • Typ - typ projektu, do wyboru:
    • PlusWorkflow– projekt kliencki PlusWorkflow
    • Wtyczka - wtyczka 

       

      W przypadku wtyczki nazwa projektu musi stanowić klucz wtyczki.

Ochrona dostępu

Dostęp do projektu może być ograniczony do poszczególnych klientów. Domyślnie projekt jest publiczny co oznacza że każdy klient może pobrać aktualizacje do takiego projektu. Możemy ograniczyć dostęp do projektu tylko dla poszczególnych klientów jeżeli:

  • dane w projekcie mogą być poufne
  • projekt dostępny jest tylko dla klientów którzy np. kupili wtyczkę

Tworzenie kanału aktualizacji

Kanał aktualizacji tworzymy poprzez podanie nazwy [A-z 0-9 - _] a następnie klikamy na przycisk 

Dostępne aktualizacje

Dostępne aktualizacje przechowywane w danym kanale możemy sprawdzić klikając na ikonę . Spowoduje to wyświetlenie pokazującego dostępne aktualizacje:

  • wierzchołki grafu to wersje projektu
  • krawędzie grafu to dostępne aktualizacje

Szczegóły aktualizacji możemy sprawdzić klikając na krawędź. Dostępne są informacje m.in. o:

  1. identyfikatorze aktualizacji
  2. wersjach od, do
  3. wersji systemu PlusWorkflow i CUF (tylko dla projektów typu PlusWorkflow)
  4. Lista zmienionych plików w aktualizacji A U D
    1. A: dodany plik
    2. U: zaktualizowany plik
    3. D: usunięty plik

 

Specjalny wierzchołek  oznacza "każdą wersję" – jeżeli od tego wierzchołka odchodzi krawędź do wersji X - oznacza to że do wersji X możemy dokonać aktualizacji z dowolnej wersji.

Dziennik zdarzeń

Zakładka Dziennik zdarzeń pozwala przejrzeć wszystkie zarejestrowane zdarzenia z informacją o kliencie, środowisku itd. Dostępne typy zdarzeń:

  • PATCH_DOWNLOAD - paczka aktualizacji została pobrana
  • PATCH_UPLOAD - paczka aktualizacji została wgrana na serwer
  • UPDATE_SUCCESS - aktualizacja powiodła się
  • UPDATE_ERROR - aktualizacja zakończyła się błędem
  • ROLLBACK_SUCCESS - przywrócenie kopii zapasowe powiodło się
  • ROLLBACK_ERROR - przywrócenie kopii zapasowej zakończyło się błędem

Szczegóły zdarzeń

Jeżeli widoczna jest ikona  oznacza to że dostępne są dodatkowe Szczegóły zdarzenia. W przypadku zdarzeń dotyczących aktualizacji albo rollbacku dostępne są też informacje o stanie walidacji przed aplikacją patcha lub informacje o błędach.

 

 

 

  • No labels