Jak skonfigurować Edge

Aby skonfigurować Edge po instalacji, używasz kombinacji plików .properties i narzędzi Edge. Aby na przykład skonfigurować TLS/SSL w interfejsie użytkownika Edge, zmień .properties pliki w celu ustawienia wymaganych właściwości. Zmiany w plikach .properties wymagają ponownego uruchomienia komponentu Edge, którego dotyczy problem.

Apigee to technika edytowania plików .properties jako kodu z konfiguracją (czasami w skrócie CwC). Ogólnie rzecz biorąc, kod z konfiguracją to narzędzie do wyszukiwania par klucz-wartość, które działa zgodnie z ustawieniami w plikach .properties. W kodzie z konfiguracją klucze są nazywane tokenami. Dlatego aby skonfigurować Edge, musisz ustawić tokeny w plikach .properties.

Kod z konfiguracją pozwala komponentom Edge ustawiać domyślne wartości wysyłane wraz z produktem, umożliwia zespołowi instalacji zastępowanie tych ustawień na podstawie topologii instalacji, a następnie pozwala klientom zastępować wybrane przez nich właściwości.

Jeśli potraktujesz je jako hierarchię, ustawienia klientów będą uporządkowane w taki sposób: ustawienia klienta o najwyższym priorytecie zastępują wszystkie ustawienia z zespołu instalatorów lub Apigee:

1. Klient
2. Instalator
3. Komponent

Określanie bieżącej wartości tokena

Zanim ustawisz nową wartość tokena w pliku .properties, musisz najpierw ustalić jej bieżącą wartość, korzystając z 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.

Poniższy przykład pokazuje sprawdzanie bieżącej wartości 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 wyglądać tak:

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 ona skomentowana. Aby ją zmienić, musisz użyć składni specjalnej. Więcej informacji znajdziesz w artykule Ustawianie tokena, który jest aktualnie komentowany.

Jeśli nie znasz całej nazwy tokena, użyj narzędzia takiego jak grep, aby wyszukać nazwę usługi lub słowo kluczowe. Więcej informacji znajdziesz w artykule Znajdowanie tokena.

Pliki właściwości

Dostępne są edytowalne i nieedytowalne pliki konfiguracji komponentów. Ta sekcja zawiera opis tych plików.

Edytowalne pliki konfiguracji komponentów

W tabeli poniżej znajdziesz komponenty Apigee i pliki właściwości, które możesz edytować, by je skonfigurować:

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

Musisz też upewnić się, ż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ć, są też pliki konfiguracji, których nie można edytować.

Pliki informacyjne (nieedytowalne) zawierają:

/opt/apigee/token

/opt/apigee/component_name/conf

Ustawianie wartości tokena

Możesz zmodyfikować tylko pliki .properties w katalogu /opt/apigee/customer/application. Każdy komponent ma własny plik .properties w tym katalogu. 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ą widoczną w tabeli powyżej.
2. Zmień właściciela pliku na „apigee:apigee”, jak w tym przykładzie:

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

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

Gdy uaktualnisz Edge, pliki .properties z katalogu /opt/apigee/customer/application zostaną odczytane. Oznacza to, że uaktualnienie zachowa wszystkie właściwości określone w komponencie.

Aby ustawić wartość tokena:

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

   conf_http_HTTPRequest.line.limit=10k

   Jeśli token zawiera wiele wartości, rozdziel je przecinkami, tak 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, zazwyczaj umieszczasz ją na końcu.

3. Uruchom ponownie komponent:

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

   Gdzie component_name jest jedną z tych wartości:

   • 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 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. Na 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 artykule Określanie bieżącej wartości tokena.

Znajdź token

W tym przewodniku przedstawiamy większość tokenów, które musisz ustawić. Jeśli jednak chcesz zastąpić wartość dotychczasowego tokena, którego nazwa lub lokalizacja nie są pewne, użyj grep do przeszukania katalogu source komponentu.

Jeśli np. wiesz, że w poprzedniej wersji Edge ustawiasz właściwość session.maxAge i chcesz poznać wartość tokena użytego do jej ustawienia, to w przypadku usługi w katalogu /opt/apigee/edge-ui/source ustaw grep:

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

Wynik powinien wyglądać tak:

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

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

/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óry możesz ustawić w pliku .properties interfejsu użytkownika.

Ustaw token aktualnie komentowany

Niektóre tokeny są komentowane w plikach konfiguracyjnych Edge. Jeśli spróbujesz ustawić token z komentarzem w pliku konfiguracji instalacji lub komponentu, ustawienie zostanie zignorowane.

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

conf/filename+propertyName=propertyValue

Aby na przykład ustawić właściwość o nazwie HTTPClient.proxy.host w procesie przetwarzania wiadomości, najpierw określ właściwość grep w przypadku tej usługi:

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

Polecenie grep zwraca wyniki zawierające nazwę tokena. Zwróć uwagę na sposób dodawania nazwy właściwości wraz z prefiksem #:

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, edytuj /opt/apigee/customer/application/message-processor.properties, ale użyj specjalnej składni, jak w tym przykładzie:

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

W takim przypadku musisz poprzedzać nazwę właściwości conf/http.properties+. Jest to lokalizacja i nazwa 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 zobaczysz ustawioną właściwość w postaci:

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