Edge for Private Cloud wer. 4.17.05
Aby skonfigurować Edge po instalacji, użyj kombinacji plików .properties i narzędzi Edge. Jeśli na przykład chcesz skonfigurować protokół TLS/SSL w interfejsie użytkownika Edge, musisz zmodyfikować pliki .properties, aby ustawić niezbędne właściwości. Zmiany w plikach .properties wymagają ponownego uruchomienia komponentu Edge, którego dotyczy problem.
Apigee odnosi się do techniki edytowania plików .properties jako kodu z config. Zasadniczo kod z konfiguracją to narzędzie do wyszukiwania par klucz-wartość oparte na ustawieniach plików .properties. W kodzie z konfiguracją klucze są określane jako tokeny. Dlatego w celu skonfigurowania Edge musisz ustawić tokeny w plikach .properties.
Kod z konfiguracją pozwala komponentom Edge na ustawianie wartości domyślnych, które są udostępniane wraz z usługą, a zespół instalacji pozwala zastępować te ustawienia na podstawie topologii instalacji, a następnie pozwala klientom zastępować wybrane przez siebie właściwości.
Jeśli uważasz, że to hierarchia, ustawienia są uporządkowane w następujący sposób: ustawienia klienta mają najwyższy priorytet, aby zastąpić ustawienia z zespołu instalatora lub Apigee:
- Klient
- Instalator
- Apigee
Jak używać plików .properties
Jako klient możesz modyfikować tylko pliki .properties w katalogu /opt/apigee/customer/application. Każdy komponent ma w tym katalogu własny plik .properties. Na przykład router.properties i management-server.properties.
- Utwórz plik w edytorze jako dowolny użytkownik.
- Zmień właściciela pliku na apigee:apigee lub, w przypadku zmiany użytkownika korzystającego z usługi Edge z użytkownika apigee, wymień plik na użytkownika, który używa usługi Edge.
Aby ustawić właściwość komponentu, zmodyfikuj odpowiedni plik .properties, by ustawić token, a potem ponownie uruchom komponent:
> /opt/apigee/apigee-service/bin/apigee-service component restart
Na przykład po wprowadzeniu zmian w pliku router.properties uruchom ponownie router:
> /opt/apigee/apigee-service/bin/apigee-service edge-router restart
Podczas uaktualniania Edge są odczytywane pliki .properties w katalogu /opt/apigee/customer/application. Oznacza to, że uaktualnienie zachowa wszystkie właściwości ustawione w komponencie.
Lokalizacja plików .properties
Istnieją 3 katalogi najwyższego poziomu z plikami .properties komponentów Edge: właściciel instalacji i klienci. Domyślne lokalizacje są pokazane w tej tabeli:
Ostrzeżenie: klienci Edge mogą modyfikować pliki .properties tylko w sekcji /opt/apigee/customer. Możesz wyświetlać pliki w katalogach komponentów i instalacji, ale nie modyfikuj żadnych plików.
|
Owner |
Domyślny katalog główny tokena |
|---|---|
|
Komponent |
/opt/apigee/<prefix>-<component>/conf gdzie /<prefiks>-<komponent> wskazuje komponent, np. router Edge lub apigee-cassandra. |
|
Instalacja |
/opt/apigee/token |
|
Klient |
/opt/apigee/customer |
Określenie bieżącej wartości tokena
Zanim ustawisz token w pliku .properties komponentu, możesz najpierw określić jego aktualną wartość, korzystając z tego polecenia:
> /opt/apigee/apigee-service/bin/apigee-service comp configure -search token
gdzie comp to nazwa komponentu, a token to token do sprawdzenia.
To polecenie przeszukuje hierarchię plików .properties, aby określić bieżącą wartość tokena.
Aby na przykład sprawdzić bieżącą wartość tokena conf_http_HTTPRequest.line.limit dla routera:
> /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit
Dane wyjściowe powinny mieć postać:
Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties
Ustawianie tokenów w plikach .properties
Aby zastąpić wartość tokena:
- Aby ustawić wartość tokena, edytuj plik .properties komponentu. Jeśli plik nie istnieje, utwórz go.
- Ponownie uruchom komponent.
- Sprawdź wartość tokena.
Aby na przykład ustawić limit wierszy żądań dla routera brzegowego:
- Edytuj plik /opt/apigee/customer/application/router.properties, aby ustawić token conf_http_HTTPRequest.line.limit:
conf_http_HTTPRequest.line.limit=8k - Ponownie uruchom router brzegowy:
> /opt/apigee/apigee-service/bin/apigee-service Edge-router restart - Sprawdź wartość tokena:
> /opt/apigee/apigee-service/bin/apigee-service Edge-router configure -search conf_http_HTTPRequest.line.limit
Ustawianie tokena, który ma wiele wartości
Niektóre tokeny przyjmują listę wartości rozdzielonych przecinkami. Na przykład token conf_security_rbac.restricted.resources pobiera listę identyfikatorów URI z ograniczeniami, aby tylko administrator mógł je wywoływać. Aby wyświetlić wartość conf_security_rbac.restricted.resources:
> cd /opt/apigee/edge-management-server > grep -ri "conf_security_rbac.restricted.resources" *
Dane wyjściowe zawierają:
token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status
Aby skonfigurować token, który pobiera listę wartości, w pliku .properties dodaj wszelkie nowe wartości do bieżącej wartości tokena. Aby więc dodać identyfikator URI /myuri/* do pliku conf_security_rbac.restricted.resources, zmodyfikuj plik /opt/apigee/customer/application/management-server.properties jak poniżej:
conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*
Znajdowanie tokena
W większości przypadków tokeny, które musisz ustawić, są wskazane w tym przewodniku. Jeśli jednak chcesz ustalić token używany do zastąpienia właściwości, wykonaj polecenie grep w folderze source komponentu.
Jeśli na przykład wiesz, że w poprzedniej wersji Edge ustawiono właściwość session.maxAge i chcesz poznać wartość tokena użytą do jej skonfigurowania, użyj polecenia grep dla właściwości w katalogu /opt/apigee/edge-ui/source:
> grep -ri "session.maxAge" /opt/apigee/edge-ui/source
Wynik powinien mieć postać:
/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}
Ciąg znaków między tagami {T}{/T} to token ustawiony w pliku .properties.
Ustawianie tokena, który jest obecnie komentowany
Niektóre tokeny są oznaczone w komentarzach w plikach konfiguracji Edge. Jeśli spróbujesz ustawić token z komentarzem, ustawienie to będzie ignorowane.
Aby ustawić komentowany token, użyj specjalnej składni w formularzu:
conf/file.extension+propertyName=propertyValue
Załóżmy na przykład, że chcesz ustawić w procesorze wiadomości właściwość o nazwie HTTPClient.proxy.host. Następnie użyj polecenia grep dla właściwości, aby określić jej token:
> cd /opt/apigee/edge-message-processor > grep -ri "HTTPClient.proxy.host" *
Polecenie grep zwraca wyniki w formie zawierającej wartość tokena. Zwróć uwagę na komentowanie nazwy właściwości, co wskazuje prefiks # w nazwie:
source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=
Aby skonfigurować właściwość, edytuj plik /opt/apigee/customer/application/message-processor.properties i ustaw ją jako:
conf/http.properties+HTTPClient.proxy.host=myhost.name.com
Zwróć uwagę, że nazwa właściwości jest poprzedzona ciągiem conf/http.properties+, lokalizacją i nazwą pliku konfiguracji zawierającego właściwość, po której następuje znak „+”.
Po ponownym uruchomieniu procesora wiadomości sprawdź plik /opt/apigee/edge-message-processor/conf/http.properties:
> cat /opt/apigee/edge-message-processor/conf/http.properties
Na końcu pliku będzie widoczny zestaw właściwości w postaci:
conf/http.properties:HTTPClient.proxy.host=myhost.name.com