Jak skonfigurować Edge

Aby skonfigurować Edge po instalacji, użyj kombinacji plików .properties i narzędzia Edge. Aby na przykład skonfigurować TLS/SSL w interfejsie Edge, edytuj pliki .properties, aby ustawić niezbędne właściwości. Zmiany w plikach .properties wymagają ponownego uruchomienia danego komponentu Edge.

Apigee odnosi się do metody edytowania plików .properties jako kodu z config (czasami w skrócie CwC). Zasadniczo kod z konfiguracją służy do wyszukiwania par klucz-wartość. na podstawie ustawień w plikach .properties. W kodzie z konfiguracją klucze są nazywane tokeny. Dlatego, aby skonfigurować Edge, należy ustawić tokeny w regionie .properties. .

Kod z konfiguracją pozwala komponentom Edge ustawiać wartości domyślne wysyłane wraz z pozwala zespołowi instalacyjnego nadpisać te ustawienia na podstawie topologii instalacji Dzięki temu klienci mogą zastąpić wybrane przez siebie właściwości.

Jeśli myślisz o hierarchii, ustawienia są rozmieszczone w ten sposób: ustawienia o najwyższym priorytecie, które zastępują wszelkie ustawienia wprowadzone przez zespół instalujący 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 określić jego bieżącą wartość, używając 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 w celu określić bieżącą wartość tokena.

W tym przykładzie sprawdzamy bieżącą wartość tokena conf_http_HTTPRequest.line.limitRoutera:

/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 ona skomentowana i musisz użyć specjalną składnię, aby ją zmienić. Więcej informacji: Ustaw token 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 części Znajdź .

Pliki właściwości

Istnieją edytowalne i nieedytowalne pliki konfiguracji komponentów. W tej sekcji znajdziesz opis tych problemów: .

Edytowalne pliki konfiguracji komponentu

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

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

Dodatkowo musisz się upewnić, że plik właściwości należy do „apigee”. użytkownik:

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

Nieedytowalne pliki konfiguracji komponentów

Oprócz edytowalnych plików konfiguracji komponentów dostępne są też pliki konfiguracji których nie można edytować.

Pliki informacyjne (nieedytowalne) to między innymi:

/opt/apigee/token

/opt/apigee/component_name/conf

Ustaw wartość tokena

Pliki .properties można modyfikować tylko w /opt/apigee/customer/application. Każdy komponent ma swoje własne .properties w tym katalogu. Na przykład: router.properties i management-server.properties. Pełną listę plików właściwości znajdziesz Więcej informacji: Lokalizacja plików .properties.

Aby utworzyć plik .properties:

1. Utwórz nowy plik tekstowy w edytorze. Nazwa pliku musi odpowiadać liście wyświetlanej w tabeli powyżej.
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 „apigee” użytkownika, należy użyć funkcji chown, aby zmienić własność na użytkownika korzystającego z Edge posprzedażna.

Po zaktualizowaniu Edge pliki .properties w Katalog /opt/apigee/customer/application został odczytany. Oznacza to, że podczas uaktualniania zostaną zachowane 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 jest ustawiona 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, musisz zwykle dodać nową wartość na końcu z listy.

3. Ponownie uruchom komponent:

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

   Gdzie component_name to jeden 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 wprowadzeniu zmian w elemencie 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ść za pomocą Opcja: 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: Określ bieżącą wartość tokena.

Znajdź token

W większości przypadków tokeny, które należy skonfigurować, są wymienione w tym przewodniku. Jeśli jednak potrzebujesz aby 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 session.maxAge właściwość i chcesz poznać wartość tokena użytą do jej skonfigurowania, a następnie grep dla usługi w /opt/apigee/edge-ui/source katalogu:

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

Wynik powinien mieć następujący format:

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

Poniższy przykład pokazuje 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 między tagami {T}{/T} to nazwa tokena, który możesz ustawić w pliku .properties interfejsu użytkownika.

Ustaw token obecnie komentowany

Niektóre tokeny są wytłumaczone w komentarzu w plikach konfiguracyjnych Edge. Jeśli spróbujesz ustawić token, który zostanie oznaczony jako komentarz w pliku instalacyjnym lub pliku konfiguracji komponentu, ustawienie zostanie zignorowane.

Aby ustawić wartość tokena komentowanego w pliku konfiguracji Edge, użyj specjalnego w takiej postaci:

conf/filename+propertyName=propertyValue

Aby na przykład ustawić właściwość o nazwie HTTPClient.proxy.host w sekcji Wiadomości, Podmiot przetwarzający, najpierw grep dla usługi, aby określić jej token:

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

Polecenie grep zwraca wyniki zawierające nazwę tokena. Uwaga jak dodaje się nazwę 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, edytuj /opt/apigee/customer/application/message-processor.properties, ale użyj specjalnego jak w tym przykładzie:

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

W tym przypadku musisz poprzedzić nazwę właściwości ciągiem conf/http.properties+. Ten to lokalizacja i nazwa pliku konfiguracji zawierającego właściwość, po którym następuje znak „+”.

Po ponownym uruchomieniu usługi Message Processor sprawdź plik: /opt/apigee/edge-message-processor/conf/http.properties:

cat /opt/apigee/edge-message-processor/conf/http.properties

Na końcu pliku zobaczysz zestaw właściwości w formacie:

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

Skonfiguruj serwer proxy przekierowania dla żądań z sekcji wysyłania żądań w interfejsie Trace

W tej sekcji wyjaśniono, jak skonfigurować serwer proxy przekierowania dla żądań z Sekcja wysyłania żądań w interfejsie Trace z opcjonalnymi danymi uwierzytelniającymi serwera proxy. Aby skonfigurować serwer proxy przekierowania:

1. Edytuj pole /opt/apigee/customer/application/ui.properties i upewnij się, że plik jest należy do: apigee:apigee.
2. Dodaj te zastąpienia (zmieniając wartości zgodnie z konkretną konfiguracją serwera proxy):

   conf_application_http.proxyhost=proxy.example.com
   conf_application_http.proxyport=8080
   conf_application_http.proxyuser=apigee
   conf_application_http.proxypassword=Apigee123!

3. Zapisz i ponownie uruchom klasyczny interfejs.

Dodaj niestandardowy format logu w routerze Apigee/Nginx

W niektórych przypadkach konieczna była zmiana domyślnego formatu logu Apigee Router/Nginx lub dodawania zmiennych. Aby zaktualizować domyślny format logów routera Apigee lub Nginx:

1. Utwórz plik router.properties, jeśli nie istnieje. W tym celu użyj poniższej ścieżki:

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

2. Dodaj te treści do pliku router.properties aby utworzyć nową konfigurację log_format o nazwie router_new:

   conf_load_balancing_load.balancing.driver.nginx.global.http.parameters.template.extra=log_format router_new 'time_iso8601\\\\thostname\\\\tremote_addr:remote_port\\\\t'\\\\n\\n 'upstream_addr\\\\trequest_time\\\\t-\\\\t-\\\\t'\\\\n\\n 'status\\\\tupstream_status\\\\trequest_length\\\\t'\\\\n\\n 'body_bytes_sent\\\\t'\\\\n\\n 'request\\\\tupstream_http_x_apigee_message_id\\\\t'\\\\n\\n 'http_user_agent\\\\thost\\thostname-pid-connection-connection_requests\\\\tmy_nginx_var_xff\\t'\\\\n\\n 'upstream_http_x_apigee_fault_flag\\\\tupstream_http_x_apigee_fault_source\\\\tupstream_http_x_apigee_fault_code\\\\t'\\\\n\\n 'upstream_http_x_apigee_fault_policy\\tupstream_http_x_apigee_fault_flow\\tupstream_http_x_apigee_fault_revision\\t'\\\\n\\n 'upstream_http_x_apigee_dp_color\\\\tmy_x_apigee_target_latency\\\\t'\\\\n\\n 'upstream_http_x_apigee_proxy\\\\tupstream_http_x_apigee_proxy_basepath\\\\t'\\\\n\\n 'self_region\\\\tself_pod\\\\tself_color\\\\tssl_protocol\\\\tssl_client_verify\\\\tssl_session_id\\\\tssl_session_reused\\\\tupstream_pod\\\\tupstream_region';\\\\n\\n\n
   conf_load_balancing_load.balancing.driver.nginx.access.log={conf_load_balancing_load.balancing.driver.nginx.log.dir}/{org}~{env}.{port}_access_log router_new

   Zaktualizuj odpowiednio zmienne w powyższych poleceniach. Domyślne ustawienia znajdziesz wartości konfiguracyjne dla funkcji log_format w pliku poniżej:

   /opt/apigee/edge-router/conf/load_balancing.properties

   Lista zmiennych Nginx jest dostępna na stronie http://nginx.org/en/docs/varindex.html.

3. Ponownie uruchom router, aby zastosować nową konfigurację:

   apigee-service edge-router restart

4. Sprawdź, czy nowa konfiguracja log_format (router_new) została dodana do pliku /opt/nginx/conf.d/0-default.conf:

       
   cat /opt/nginx/conf.d/0-default.conf | grep router_new -A 10

5. Wyślij żądania interfejsu API do serwera proxy i sprawdź nowy format dziennika w pliku.

   /opt/apigee/var/log/edge-router/nginx/${org}~${env}.${port}_access_log file