Praca z Pantheon

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

Apigee korzysta z Pantheon, usługi do zarządzania witryną, do hostowania wersji portalu usług dla programistów działających w chmurze. Pantheon współpracuje z Drupal, dzięki czemu możesz tworzyć, testować i publikować portale w bezpiecznym środowisku. Usługa zarządzania witryną firmy Pantheon jest dostępna dla klientów z całego świata zajmujących się hostingiem i programowaniem.

W kolejnych sekcjach opisano, jak za pomocą Pantheon tworzyć portal i nim zarządzać.

Otwieranie panelu Pantheon

Gdy Apigee wyśle Ci adres URL portalu, otrzymasz też adres URL panelu Pantheon: https://dashboard.getpantheon.com/.

Gdy po raz pierwszy zalogujesz się w panelu Pantheon, otworzy się strona Witryny, którą widać poniżej:

Za jego pomocą możesz uzyskać dostęp do swojej witryny, skonfigurować konto i wykonać inne operacje.

Wybierz obraz swojej witryny (np. apigeedocs), aby otworzyć panel tej witryny:

Zarządzanie środowiskami

W panelu Pantheon u góry strony znajdują się 3 środowiska: deweloperskie, testowe i aktywne. Każdy z nich został opisany w poniższej tabeli.

Środowisko

Opis

Dla programistów

Środowisko Dev jest połączone z Twoim repozytorium Git. Wszystkie zmiany przekazywane do Git pojawią się od razu w środowisku deweloperskim.

Adres URL tej witryny ma format poniżej (org_name to nazwa Twojej organizacji):

http://dev-{org_name}.devportal.apigee.io/

Testuj

Środowisko testowe służy do testowania najnowszego kodu z kopią danych z aktywnego środowiska. W tym środowisku testujesz zmiany w kodzie przed przekazaniem go do aktywnego środowiska.

Adres URL tej witryny ma format poniżej (org_name to nazwa Twojej organizacji):

http://test-{org_name}.devportal.apigee.io/

Aktywna

Aktywne środowisko to środowisko produkcyjne, które jest dostępne dla klientów.

Adres URL tej witryny ma format poniżej (org_name to nazwa Twojej organizacji):

http://live-{org_name}.devportal.apigee.io/

Tworzenie treści portalu

W kolejnych sekcjach opisano, jak zaprojektować zawartość portalu.

Dodatkowo w poniższych sekcjach znajdziesz więcej informacji na temat dostosowywania portalu.

Jeśli chcesz...

Możesz

Więcej informacji

zmieniać wygląd i sposób działania witryny,

Podstawowe – korzystając z wpisu w menu Wygląd w witrynie portalu, możesz wprowadzać zmiany, takie jak zmiana logo i kolorów witryny.

Zobacz Dostosowywanie wyglądu:

Zaawansowane – aby zmienić pełny wygląd i styl witryny, rozszerz motyw elastyczny Apigee.

Patrz: Dostosowywanie motywu.

Zmień działanie funkcji witryny

Podstawowe – użyj ustawień administratora w portalu, aby zmienić lub skonfigurować sposób działania witryny.

Dokumentację Apigee znajdziesz tutaj

Zaawansowane – utwórz moduł niestandardowy, aby zmienić dowolne działanie witryny.

Zapoznaj się z sekcją Tworzenie modułów niestandardowych w dokumentacji Drupala.

Omówienie repozytorium Git

Repozytorium Git dla kodu Drupal zawiera cały kod portalu i jest uporządkowane według poniższej struktury.

Uwaga: modyfikuj tylko zawartość katalogu /sites/all. Jeśli zmodyfikujesz treść spoza katalogu /sites/all, przy uaktualnianiu do nowych wersji wystąpią problemy i mogą wystąpić konflikty scalania podczas sprawdzania zmian w Git.

Folder w repozytorium Git

Opis

/profiles/apigee

Apigee utrzymuje moduły i motywy, w tym:

  • /profiles/apigee/modules/contrib: moduły Contrib Drupal obsługiwane przez Apigee
  • /profiles/apigee/themes/contrib: motywy Contrib w Drupal utworzone przez Apigee
  • /profiles/apigee/modules/custom: moduły niestandardowe utworzone przez Apigee
  • /profiles/apigee/themes/custom: motywy niestandardowe utworzone przez Apigee

Uwaga: nie zmieniaj zawartości katalogu /profiles/apigee, bo podczas aktualizowania do nowych wersji wystąpią problemy i mogą wystąpić konflikty scalania podczas sprawdzania zmian w Git. Sprawdzone metody dotyczące systemu Drupal znajdziesz w artykule Nigdy nie hakuj rdzeni.

/sites/all

Twoje niestandardowe moduły i motywy w systemie Drupal. Informacje o zarządzaniu zawartością w tym folderze znajdziesz w sekcjach Dodawanie niestandardowych modułów i motywów oraz Zastępowanie modułów i motywów profilu Drupal.

Uwaga: modyfikuj tylko zawartość katalogu /sites/all.

Uzyskiwanie dostępu do kodu

Aby uzyskać dostęp do repozytorium kodu w Git, musisz wykonać zadania opisane w tych sekcjach:

Zobacz też Jak uzyskać dostęp do kodu źródłowego portalu dla programistów Drupal 7?

Włączanie dostępu SSH do serwera

Zanim zaczniesz używać Git do zarządzania kodem Drupal, musisz włączyć SSH do dostępu do serwera, przesyłając klucz SSH do Pantheon.

Aby włączyć dostęp do serwera przez SSH:

  1. Zaloguj się w Pantheon na stronie https://dashboard.getpantheon.com/.
  2. W panelu kliknij Konto.
  3. W menu po lewej stronie wybierz Klucze SSH.
  4. Dodaj klucz i kliknij Dodaj klucz.
    Jeśli potrzebujesz pomocy, kliknij link Dowiedz się, jak wygenerować klucz SSH.

Dostęp do repozytorium kodu w Git

Uwaga: omówienie struktury repozytorium Git znajdziesz w artykule Omówienie repozytorium Git.

Aby uzyskać dostęp do repozytorium kodu w Git:

  1. Zaloguj się w panelu Pantheon.
  2. Na stronie głównej Witryn wybierz ikonę portalu.
  3. Adres URL repozytorium Git pojawi się na stronie po prawej stronie trybu połączenia, tak jak na poprzednim ilustracji.
  4. Skopiuj adres URL swojego repozytorium Git i skopiuj je do lokalnego środowiska programistycznego za pomocą polecenia:
    > git clone gitURL sitename
    Na przykład:
    > git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~t/repository.

Wszystkie zmiany kodu przekazywane do repozytorium Git natychmiast pojawiają się w środowisku Dev portalu.

Wdrażanie kodu w środowiskach portalu

Aby zakodować środowisko portalu:

  1. Przesyłaj aktualizacje kodu do Git, co natychmiast aktualizuje środowisko Dev.
  2. Zaloguj się do Pantheon i wybierz swoją witrynę.
  3. Wybierz środowisko Dev.
  4. Wybierz </>Kod w menu po lewej stronie, aby w dzienniku zobowiązania wyświetlić komunikat o zmianie kodu:
  5. Wybierz środowisko Testuj u góry strony.
    1. Jeśli nie udało Ci się jeszcze przesłać wersji Dev do wersji Test, pojawi się prośba o przesłanie jej teraz.
    2. Jeśli masz już środowisko testowe, pojawi się komunikat informujący o tym, że istnieje już zatwierdzenie w wersji deweloperskiej gotowe do wdrożenia:
  6. Jeśli witryna została już przekazana do aktywnego środowiska, opcjonalnie możesz zaznaczyć trzecie pole wyboru, aby skopiować opublikowaną bazę danych i wszystkie pliki przesłane przez deweloperów do testu z poziomu aktywnego. Jest to przydatne, gdy chcesz przetestować zmiany w kodzie w porównaniu z najnowszymi danymi dostępnymi w wersji opublikowanej.
  7. Kliknij przycisk Wdróż kod z projektowania.
  8. Przetestuj portal w środowisku testowym.
  9. Wprowadź poprawki w kodzie w środowisku deweloperskim i ponownie prześlij pliki do środowiska Test w celu przetestowania.
  10. Po zakończeniu testu wybierz Aktywne środowisko u góry strony.
    1. Jeśli test nie został jeszcze przesłany jako aktywny, poprosimy Cię o jego przesłanie teraz.
    2. Jeśli masz już aktywne środowisko, pojawi się komunikat informujący o tym, że istnieje zatwierdzenie z testu gotowe do wdrożenia. Wdróż te zmiany w taki sam sposób jak w przypadku testów z poziomu dewelopera. Po zakończeniu testowania wypchnij kod do środowiska aktywnego.

Więcej informacji:

Dodawanie niestandardowych modułów i motywów

Możesz rozszerzyć funkcjonalność portalu, dodając własne niestandardowe moduły i motywy do folderów wymienionych w poniższej tabeli.

Uwaga: modyfikuj tylko zawartość katalogu /sites/all. Jeśli modyfikujesz treści spoza katalogu /sites/all, podczas sprawdzania zmian w Git mogą wystąpić konflikty scalania.

Moduł/motyw Folder w repozytorium Git Więcej informacji (dokumentacja Drupala)
Moduły niestandardowe sites/all/modules/custom Tworzenie modułów niestandardowych
Motywy niestandardowe sites/all/themes Dostosowywanie motywu
Theming Drupal 7

Po dodaniu modułu niestandardowego lub motywu w środowisku deweloperskim możesz go wdrożyć w środowisku testowym, a następnie w aktywnym środowisku produkcyjnym zgodnie z opisem w sekcji Wdrażanie kodu w środowiskach portalu.

Zastępowanie modułów i motywów profilu Drupal

Moduły i motywy w poniższych katalogach zastępują moduły i motywy profilu Drupal obsługiwane i rozpowszechniane przez Apigee w katalogu /profiles/apigee. Zobacz Omówienie repozytorium Git.

Możesz na przykład zastąpić moduł w dystrybucji Apigee Drupal w tych sytuacjach:

  • Chcesz użyć innej wersji danego modułu.
  • Chcesz wdrożyć aktualizację zabezpieczeń przed następną zaplanowaną wersją Apigee.
Moduł/motyw Folder w repozytorium Git Więcej informacji (dokumentacja Drupala)
Moduły ze strony Drupal

sites/all/modules/contrib

Uwaga: moduły przechowywane w dowolnym miejscu w /sites/all/modules zastąpią moduły dystrybucji Apigee Drupal.

Przesłane moduły

Uwaga: moduły dodane w tym katalogu zastępują odpowiednie moduły obsługiwane i rozpowszechniane przez Apigee w /profiles/apigee/modules. Jeśli chcesz korzystać z obsługiwanych przez Apigee modułów profilu Drupal, usuń wszystkie zduplikowane moduły dodane do tego folderu.

Motywy dodane przez Drupal sites/all/themes Przesłane motywy

Uwaga: motywy opublikowane w tym katalogu zastępują odpowiednie moduły obsługiwane i rozpowszechniane przez Apigee w /profiles/apigee/themes. Jeśli chcesz używać motywów profilu obsługiwanych przez Apigee, usuń wszystkie zduplikowane moduły dodane do tego folderu.

Informacje o pliku settings.php

Element settings.php w serwisie Drupal jest przypisany do nadrzędnego repozytorium Git w portalu dla programistów Apigee Drupal. Jeśli chcesz wprowadzić zmiany w pliku sites/default/settings.php, nie edytuj go bezpośrednio. Zamiast tego utwórz plik o nazwie sites/default/settings.local.php i umieść w nim swój kod niestandardowy. Element sites/default/settings.local.php znajduje się w pliku settings.php.

Na przykład podczas konfigurowania domeny niestandardowej dla działającej witryny w sposób podany przez Pantheon, zamiast modyfikować bezpośrednio plik settings.php, dodaj wymagane aktualizacje w narzędziu sites/default/settings.local.php.

Zabezpieczanie portalu

Witryny portali powiązane ze środowiskami Dev, Test i Live są domyślnie dostępne publicznie. Oznacza to, że każdy, kto zna URL witryny, może uzyskać do niej dostęp, ale może nie być w stanie zarejestrować konta ani zalogować się do witryny. Więcej informacji na temat kontrolowania rejestracji użytkowników znajdziesz w artykule Dodawanie kont użytkowników i zarządzanie nimi.

Prawdopodobnie zechcesz ukryć witrynę dla programistów i testową przed dostępem publicznym oraz ukryć witrynę opublikowaną do czasu, aż zakończysz programowanie. Pantheon umożliwia dodanie nazwy użytkownika i hasła w celu zablokowania witryny, aby dostęp do niej mieli tylko osoby z odpowiednimi danymi logowania.

Aby dodać blokowanie do dowolnego z 3 środowisk, kliknij Zabezpieczenia w menu po lewej stronie. Więcej informacji znajdziesz w artykule Blokowanie witryny.

Jeśli chcesz włączyć TLS/SSL w witrynie, przeczytaj artykuł Korzystanie z protokołu TLS w portalu.

Stosuję aktualizację Apigee do portalu

Gdy Apigee opublikuje nową wersję portalu, w panelu Pantheon pojawi się komunikat.

Zwykle wprowadzasz aktualizację w środowisku deweloperskim, a potem testujesz te zmiany w ten sam sposób, w jaki testujesz własne zmiany w kodzie. Na przykład przekaż środowisko Dev do środowiska Test, prześlij aktywne dane z Aktywnego do Testu, a następnie przetestuj aktualizację.

Aby zastosować aktualizację:

  1. Zaloguj się w Pantheon na stronie https://dashboard.getpantheon.com/ i wybierz swoją witrynę.
  2. Wybierz środowisko Dev.
  3. Wybierz pozycję menu </>Kod z lewej strony. Jeśli aktualizacje Apigee są dostępne, zostaną wyświetlone.
  4. Zastosuj aktualizację:
    1. Zaznacz pole wyboru Uruchom aktualizację.php po pobraniu kodu.
    2. Jeśli to możliwe, zaznacz pole wyboru Wyczyść pamięć podręczną po pobraniu.
    3. Kliknij przycisk Wdróż kod.
  5. Gdy aktualizacja się zakończy, po lewej stronie panelu wybierz pozycję menu Stan.
  6. W obszarze Stan środowiska może pojawić się błąd związany z aktualizacją bazy danych, jak pokazano poniżej:

    Jeśli ten błąd wystąpi w dowolnym środowisku, ręcznie zaktualizuj bazę danych:

    1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
    2. W lewym górnym rogu portalu kliknij ikonę strony głównej > Uruchom aktualizacje.
    3. Postępuj zgodnie z instrukcjami, aby zaktualizować bazę danych.
  7. Przenieś zmiany kodu do środowiska testowego, a następnie przejdź do środowiska Aktywnego, jak opisano powyżej.

Migracja funkcji niestandardowych

Jeśli dodasz do portalu niestandardowy kod lub funkcje, musisz zdecydować, jak je obsługiwać i jak przenieść je ze środowisk Dev do Test w Aktywne.

W przypadku kodu w repozytorium Git możesz użyć procesu opisanego w artykule Wdrażanie kodu w środowiskach portalu, aby przenieść kod z Dev do Test na Live.

Jeśli masz utworzone konfiguracje niestandardowe, przenieś je za pomocą jednej z tych metod:

Metoda Opis
Eksportowanie konfiguracji do kodu Wiele popularnych konfiguracji można wyeksportować do kodu za pomocą modułu funkcji. Mogą to być na przykład widoki, panele, pamięć podręczna obrazów itd.
Wdróż funkcję hook_update_N() Drupal zarządza zmianami w bazie danych i konfiguracji przy użyciu funkcji hook_update_N().

Jeśli masz moduł niestandardowy, możesz:

  • Aby umożliwić przetworzenie zmian, dodaj funkcje hook_update_N() do pliku .install modułu.
  • Wdróż te zmiany razem z kodem.
  • Uruchom update.php, aby przenieść zmiany w środowiskach Stage i Prod.

Zapoznaj się też z sekcją Korzystanie z przepływów pracy Pantheon, która zawiera omówienie tworzenia, testowania i przekazywania witryny. Znajdziesz w nim sekcję o zarządzaniu konfiguracją.

Konfigurowanie domeny niestandardowej

Nazwy domen udostępniane przez Apigee powodują domyślne ustawienie apigee.io zgodnie z opisem w sekcji Zarządzanie środowiskami, które mogą nie być tym, co chcesz ujawniać klientom.

W przypadku płatnych abonamentów portalu można skonfigurować niestandardową nazwę domeny portalu (konta programistów ani konta bezpłatne nie mogą tworzyć domen własnych). Aby użyć domeny niestandardowej, utwórz rekord CNAME w DNS i wskaż adres edge.apigee.getpantheon.com.

Aby na przykład skonfigurować domenę niestandardową dla firmy o nazwie Mytech:

  1. Skonfiguruj to ustawienie DNS:
    developer.mytech.com. 3600 IN CNAME Edge.apigee.getpantheon.com
    Zastosowanie tej zmiany w systemie DNS na wszystkich urządzeniach klienckich może potrwać do 48 godzin.
  2. Użyj pozycji menu Domeny / SSL po lewej stronie panelu, aby dodać tę domenę do panelu Pantheon wyłącznie na potrzeby środowiska aktywnego.
    W większości przypadków konfigurujesz DNS tylko dla aktywnego środowiska, a nie Dev czy Test. Nie używaj środowisk deweloperskich ani testowych do celów produkcyjnych.

Więcej informacji znajdziesz w dokumentacji Pantheon.

Dodawanie administratorów portalu

Gdy otrzymasz z Apigee e-maila z informacją, że portal jest gotowy, będzie on już skonfigurowany w usłudze Apigee. Aby ją wyświetlić, kliknij link Zespół w prawym górnym rogu panelu witryny.

Aby dodać kolejnych administratorów, przeczytaj artykuł Tworzenie administratorów.

Tworzę kopię zapasową portalu

Aby utworzyć kopię zapasową portalu, użyj karty Kopie zapasowe w panelu Pantheon. Możesz utworzyć kopię zapasową na żądanie lub automatyczną kopię zapasową. W usłudze Pantheon kopia zapasowa składa się z 3 osobnych archiwów: bazy danych, plików i kodu.

Więcej informacji znajdziesz w sekcji Narzędzie do tworzenia kopii zapasowych w dokumentacji usługi Pantheon.

Subskrybowanie aktualizacji stanu

Aktualizacje wersji i stanu Apigee możesz zasubskrybować na stronie status.apigee.com. Kliknij Subskrybuj aktualizacje, wpisz informacje kontaktowe, takie jak adres e-mail, gdy pojawi się prośba, a następnie kliknij Subskrybuj. Na stronie zarządzania powiadomieniami e-mail zaznacz Portal dla programistów, w razie potrzeby zmień inne ustawienia powiadomień i kliknij Zaktualizuj ustawienia.

Aktualności o stanie Pantheon i raporty o incydentach (na przykład informacje o przerwie w działaniu usługi) możesz zasubskrybować na stronie http://status.getpantheon.com. Kliknij Subskrybuj aktualizacje, aby się zarejestrować.