Jak skonfigurować Edge

Aby skonfigurować Edge po instalacji, musisz użyć kombinacji plików .properties i narzędzi Edge. Jeśli na przykład chcesz skonfigurować TLS/SSL w interfejsie użytkownika Edge, musisz zmodyfikować pliki .properties w celu ustawienia wymaganych 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 konfiguracją (czasami w skrócie CwC). 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.

Ustawienia są przedstawione w następujący sposób: ustawienia klienta mają najwyższy priorytet, aby zastąpić ustawienia z zespołu instalatora lub Apigee:

1. Klient
2. Instalator
3. Komponent

Określ bieżącą wartość tokena

Zanim ustawisz nową wartość tokena w pliku .properties, musisz najpierw określić jego bieżącą wartość przy użyciu tego polecenia:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

Gdzie component_name to nazwa komponentu, a token to token do sprawdzenia.

To polecenie przeszukuje hierarchię plików .properties komponentu, aby określić bieżącą wartość tokena.

Ten przykład pozwala sprawdzić bieżącą wartość tokena conf_http_HTTPRequest.line.limit routera:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Zostaną wyświetlone dane wyjściowe podobne do tych:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

Jeśli wartość tokena zaczyna się od #, została oznaczona jako komentarz. Aby ją zmienić, musisz użyć specjalnej składni. Więcej informacji znajdziesz w artykule o ustawianiu tokena, który jest obecnie komentowany.

Jeśli nie znasz całej nazwy tokena, użyj narzędzia takiego jak grep, aby wyszukać według nazwy właściwości lub słowa kluczowego. Więcej informacji znajdziesz w artykule o znajdowaniu tokena.

Pliki właściwości

Istnieją pliki konfiguracji komponentów, które można edytować i których nie można edytować. Pliki te są opisane w tej sekcji.

Pliki konfiguracji komponentów, które można edytować

W tabeli poniżej znajdziesz listę komponentów i plików właściwości Apigee, które możesz edytować, aby skonfigurować te komponenty:

Jeśli chcesz ustawić właściwość w jednym z tych plików konfiguracji komponentu, ale ona nie istnieje, możesz ją utworzyć w wymienionej powyżej lokalizacji.

Oprócz tego musisz się upewnić, że plik właściwości należy do użytkownika „apigee”:

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

Pliki konfiguracji komponentów, których nie można edytować

Oprócz plików konfiguracji komponentów, które można edytować, istnieją też pliki konfiguracji, których nie można edytować.

Pliki informacyjne (których nie można edytować) obejmują:

/opt/apigee/token

/opt/apigee/component_name/conf

Ustaw wartość tokena

Możesz modyfikować tylko pliki .properties znajdujące się 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. Pełną listę plików właściwości znajdziesz w sekcji Lokalizacja plików .properties.

Aby utworzyć plik .properties:

1. Utwórz nowy plik tekstowy w edytorze. Nazwa pliku musi być zgodna z listą wyświetlaną w tabeli powyżej w przypadku plików klientów.
2. Zmień właściciela pliku na „apigee:apigee”, jak pokazano w tym przykładzie:

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   Jeśli zmienisz użytkownika, który uruchamia usługę Edge, z użytkownika „apigee”, użyj chown, aby zmienić właściciela na użytkownika, który używa usługi Edge.

Po zaktualizowaniu Edge są odczytywane pliki .properties z katalogu /opt/apigee/customer/application. Oznacza to, że uaktualnienie zachowa wszystkie właściwości ustawione w komponencie.

Aby ustawić wartość tokena:

1. Edytuj plik .properties komponentu.
2. Dodaj lub zmień wartość tokena. W tym przykładzie wartość właściwości conf_http_HTTPRequest.line.limit ustawiono na „10k”:

   conf_http_HTTPRequest.line.limit=10k

   Jeśli token przyjmuje wiele wartości, rozdziel je przecinkami jak w tym przykładzie:

   conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

   Aby dodać nową wartość do takiej listy, zwykle trzeba ją dodać na końcu listy.

3. Ponownie uruchom komponent:

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   Gdzie component_name jest jednym z tych elementów:

   • apigee-cassandra (Cassandra)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (baza danych PostgreSQL)
   • apigee-qpidd (kwartał)
   • apigee-sso (SSO – logowanie jednokrotne)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (serwer zarządzania)
   • edge-management-ui (nowy interfejs Edge)
   • edge-message-processor (procesor wiadomości)
   • edge-postgres-server (serwer Postgres)
   • edge-qpid-server (serwer Qpid)
   • edge-router (router brzegowy)
   • edge-ui (klasyczny interfejs)

   Na przykład po zakończeniu edycji router.properties uruchom ponownie router:

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

4. (Opcjonalnie) Sprawdź, czy wartość tokena jest ustawiona na nową wartość, korzystając z opcji configure -search. Przykład:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

   Więcej informacji o configure -search znajdziesz w sekcji o określaniu bieżącej wartości tokena.

Zlokalizuj token

W większości przypadków tokeny, które musisz ustawić, są wskazane w tym przewodniku. Jeśli jednak chcesz zastąpić wartość istniejącego tokena, którego pełnej nazwy lub lokalizacji nie masz pewności, użyj grep, aby przeszukać katalog 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, a następnie wartość grep dla usługi w katalogu /opt/apigee/edge-ui/source:

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

Wynik powinien mieć postać:

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

Poniższy przykład przedstawia wartość tokena session.maxAge interfejsu użytkownika:

/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 nazwa tokena, którą możesz ustawić w pliku .properties interfejsu użytkownika.

Ustaw token, który jest obecnie komentowany

Niektóre tokeny są oznaczone w komentarzach w plikach konfiguracji Edge. Jeśli spróbujesz ustawić token, który jest komentowany w pliku instalacji lub pliku konfiguracji komponentu, ustawienie zostanie zignorowane.

Aby ustawić wartość tokena komentowaną w pliku konfiguracji Edge, użyj specjalnej składni w tej formie:

conf/filename+propertyName=propertyValue

Aby na przykład ustawić w procesorze wiadomości właściwość o nazwie HTTPClient.proxy.host, najpierw ustaw wartość grep dla właściwości, aby określić jej token:

grep -ri /opt/apigee/edge-message-processor/ -e "HTTPClient.proxy.host"

Polecenie grep zwraca wyniki zawierające nazwę tokena. Zwróć uwagę na sposób komentowania nazwy właściwości, co wskazuje prefiks #:

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 ustawić wartość tej właściwości, zmień właściwość /opt/apigee/customer/application/message-processor.properties, używając jednak specjalnej składni, jak w tym przykładzie:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

W takim przypadku do nazwy właściwości musisz dodać conf/http.properties+. Jest to lokalizacja i nazwa pliku konfiguracji zawierającego właściwość poprzedzoną znakiem „+”.

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