Edge for Private Cloud w wersji 4.17.09
Za pomocą narzędzia apigee-adminapi.sh możesz wykonywać te same zadania konfiguracji Edge, które wykonujesz za pomocą wywołań interfejsu Edge Management API. Zaletą narzędzia apigee-adminapi.sh jest to, że:
- Używanie prostego interfejsu wiersza poleceń
- Wprowadza autouzupełnianie poleceń po naciśnięciu tabulatora
- zawiera informacje o pomocy i użytkowaniu;
- Może wyświetlić odpowiednie wywołanie interfejsu API, jeśli zdecydujesz się go wypróbować
Narzędzie apigee-adminapi.sh nie zastępuje narzędzia apigee-provision. Narzędzie apigee-provision używa w rzeczywistości narzędzia apigee-adminapi.sh do wykonywania swoich zadań.
Główne różnice między tymi 2 strategiami to:
- Narzędzie apigee-adminapi.sh wykonuje funkcje atomowe, które zastępują poszczególne wywołania interfejsu Edge API. Na przykład utworzenie organizacji, środowiska i hosta wirtualnego wymaga 3 oddzielnych poleceń apigee-adminapi.sh odpowiadających 3 wywołaniom interfejsu API.
- Narzędzie apigee-provision zostało zaprojektowane tak, aby wykonywać kompletną operację na wysokim poziomie za pomocą jednego polecenia. Za pomocą jednego polecenia apigee-provision możesz na przykład utworzyć organizację, środowisko i hosta wirtualnego. W tym celu przekaż plik konfiguracji ze wszystkimi niezbędnymi informacjami.
Dokumentacja Edge używa obu narzędzi w odpowiednich miejscach.
Instalowanie pliku apigee-adminapi.sh
Narzędzie apigee-adminapi.sh jest instalowane automatycznie, gdy instalujesz narzędzie apigee-provision lub apigee-validate.
To narzędzie jest zainstalowane w następującej lokalizacji:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Składnia apigee-adminapi.sh
Narzędzie apigee-adminapi.sh używa prostej składni wiersza poleceń. W dowolnej chwili możesz nacisnąć klawisz Tab, aby wyświetlić prompt z dostępnymi opcjami polecenia.
Aby wyświetlić wszystkie możliwe polecenia, uruchom narzędzie bez opcji:
> apigee-adminapi.sh
Jeśli po wpisaniu apige-adminapi.sh naciśniesz klawisz Tab, zobaczysz listę możliwych opcji:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
Klawisz tabulacji wyświetla opcje zależnie od kontekstu polecenia. Jeśli naciśniesz klawisz Tab po wpisaniu:
> apigee-adminapi.sh orgs
Zobaczysz dostępne opcje wykonania polecenia orgs:
add apis apps delete envs list pods userroles
Użyj opcji -h, aby wyświetlić pomoc dotyczącą dowolnego polecenia. Jeśli na przykład użyjesz opcji -h, jak pokazano poniżej:
> apigee-adminapi.sh orgs -h
Narzędzie wyświetla pełną pomoc dotyczącą wszystkich dostępnych opcji polecenia orgs. Pierwszy element w wyniku pokazuje pomoc dotyczącą polecenia „orgs add”:
+++++++++++++++++++++++++++++++++++++++++++
orgs add
Required:
-o ORG Organization name
Optional:
-H HEADER add http header in request
--admin ADMIN_EMAIL admin email address
--pwd ADMIN_PASSWORD admin password
--host EDGE_SERVER edge server to make request to
--port EDGE_PORT port to use for the http request
--ssl set EDGE_PROTO to https, defaults to http
--debug ( set in debug mode, turns on verbose in curl )
-h Displays Help
Ustawianie parametrów za pomocą opcji wiersza poleceń i zmiennych środowiskowych
Musisz wprowadzić w poleceniu wszystkie parametry, używając przełączników wiersza poleceń lub zmiennych środowiskowych. W razie potrzeby poprzedź przełączniki wiersza poleceń pojedynczym myślnikiem (-) lub podwójnym łącznikiem (--).
Na przykład w pomocy do polecenia „orgs add” możesz podać nazwę organizacji, korzystając z jednego z tych sposobów:
- Użycie przełącznika wiersza poleceń -o:
> apigee-adminapi.sh orgs -o testOrg - Ustawianie zmiennej środowiskowej o nazwie ORG:
> export ORG=testOrg
> apigee-adminapi.sh orgs
Jeśli pominiesz wymagane parametry polecenia, narzędzie wyświetli komunikat o błędzie opisujący brakujące parametry. Jeśli na przykład podczas tworzenia organizacji pominiesz zmienną środowiskową --host lub EDGE_SERVER określającą serwer zarządzania brzegiem, zobaczysz ten komunikat o błędzie:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Dwa najpopularniejsze parametry, które często ustawiasz jako zmienne środowiskowe, to adres e-mail administratora systemu i adres IP serwera zarządzania:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Przekazywanie pliku do narzędzia apigee-adminapi.sh
Niektóre polecenia narzędzia apigee-adminapi.sh odpowiadają wywołaniom interfejsu API PUT i POST, które przyjmują treść żądania. Na przykład utworzenie hosta wirtualnego odpowiada wywołaniu interfejsu API POST, które wymaga podania informacji o hostie wirtualnym w ciele żądania.
Jeśli używasz narzędzia apigee-adminapi.sh do tworzenia hosta wirtualnego lub dowolnego polecenia, które przyjmuje treść żądania, możesz przekazać wszystkie niezbędne informacje na linii poleceń, jak pokazano poniżej:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005
Możesz też przekazać plik zawierający te same informacje, które byłyby zawarte w treści żądania POST. Na przykład to polecenie przyjmuje plik definiujący hosta wirtualnego:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
gdzie plik vhostcreate zawiera treść POST wywołania. W tym przykładzie jest to treść żądania w formacie XML:
<VirtualHost name="myVHostUtil">
<HostAliases>
<HostAlias>192.168.56.101:9005</HostAlias>
</HostAliases>
<Interfaces/>
<Port>9005</Port>
</VirtualHost>
Wyświetlanie informacji o debugowaniu i interfejsie API
Aby wyświetlić szczegółowe informacje o poleceniu, użyj opcji --debug w narzędziu apigee-adminapi.sh. Te informacje obejmują komendę cURL wygenerowaną przez narzędzie apigee-adminapi.sh w celu wykonania operacji.
Na przykład to polecenie używa opcji --debug:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
Wyświetla się taki wynik, w tym wygenerowane polecenie cURL:
curl -H Content-Type: application/xml -v -X POST -s -k -w \n==> %{http_code}
-u ***oo@bar.com:***** http://localhost:8080/v1/o -d <Organization name="testOrg2"
type="paid"/>
* About to connect() to localhost port 8080 (#0)
* Trying ::1... connected
* Connected to localhost (::1) port 8080 (#0)
* Server auth using Basic with user 'foo@bar.com'
> POST /v1/o HTTP/1.1
> Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1
Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: localhost:8080
> Accept: */*
> Content-Type: application/xml
> Content-Length: 43
>
} [data not shown]
< HTTP/1.1 201 Created
< Content-Type: application/json
< Date: Tue, 03 May 2016 02:08:32 GMT
< Content-Length: 291
<
{ [data not shown]
* Connection #0 to host localhost left intact
* Closing connection #0