Apigee TOA'yı yükleme ve yapılandırma

OPDK 4.54.00'dan itibaren TOA mimarisi modernize edilmiştir. Kimlik aracısı (Dex) artık doğrudan apigee-openldap bileşenine yerleştirilmiştir. Bu sayede, ayrı bir eski apigee-sso modülü yükleme ihtiyacı ortadan kalkar.

Apigee TOA'yı etkinleştirmek ve yapılandırmak için aşağıdakileri yapmanız gerekir:

  1. Yeni Edge kullanıcı arayüzü için makine kullanıcısı oluşturma: Yeni Edge kullanıcı arayüzünün Management API'lerini çağırması için gereken makine kullanıcısını oluşturun.
  2. Ortak yapılandırma dosyasındaki özellikleri yapılandırma: Hem OpenLDAP (TOA) hizmeti hem de yeni Edge kullanıcı arayüzü için gereken özellikleri içeren tek bir yapılandırma dosyası oluşturun.
  3. Postgres'te TOA veritabanı oluşturma: Apigee PostgreSQL örneğinde TOA için bir veritabanı oluşturun.
  4. OpenLDAP'te TOA yapılandırmalarını uygulama: OpenLDAP düğümünde entegre Apigee TOA'yı başlatmak için yapılandırma dosyasını uygulayın.
  5. Yeni Edge kullanıcı arayüzünü yapılandırma: Yeni Apigee TOA'yı kullanmak için yeni Edge kullanıcı arayüzü özelliklerini güncelleyin.

Bu adımların her biri sonraki bölümlerde açıklanmıştır.

Kullanıcı arayüzü için makine kullanıcısı oluşturma

Yeni Edge kullanıcı arayüzü, arka uçta Management API'lerini çağırmak için belirli işlemler için bir makine kullanıcısı gerektirir. Bu amaçla apigee-openldap düğümüne önceden yüklenmiş bir komut dosyası kullanılır.

Komut dosyası ve makine kullanıcıları hakkında daha fazla bilgiyi Using the apigee-machine-user script (apigee-machine-user komut dosyasını kullanma) başlıklı makalede bulabilirsiniz.

Yeni Edge kullanıcı arayüzü için makine kullanıcısı oluşturmak üzere apigee-openldap düğümünde aşağıdaki komutu kullanın ve sonraki adımda yapılandırma dosyasında özelliği tanımlarken tam olarak aynı kimlik bilgilerini kullandığınızdan emin olun. 

 /opt/apigee/apigee-openldap/bin/apigee-machineuser.sh add -u ui-machine-user@apigee.com -p Secret123

Ortak yapılandırma dosyasındaki özellikleri yapılandırma

Apigee TOA'yı ve yeni Edge kullanıcı arayüzünü etkinleştirebilmek için ortak bir yapılandırma dosyası (örneğin, /opt/silent.conf) tanımlamanız gerekir. Bu yolu ve dosya adını ortamınıza göre değiştirebilirsiniz.

/opt/silent.conf dosyanıza aşağıdaki temel yapılandırma özelliklerini ekleyin:

# ==========================================
# SSO Enablement
# ==========================================
ENABLE_SSO=y

# ==========================================
# SSO Hostname/IP and Port config for Dex
# ==========================================
SSO_PUBLIC_URL_SCHEME=http
SSO_PUBLIC_URL_HOSTNAME=localhost
SSO_PUBLIC_URL_PORT=9099

# ==========================================
# Static Client UI credentials
# ==========================================
MANAGEMENT_UI_SSO_CLIENT_ID=unifiedui
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret123

# ==========================================
# Management UI & SSO redirect URLs
# ==========================================
MANAGEMENT_UI_SCHEME=http
MANAGEMENT_UI_IP=localhost
MANAGEMENT_UI_PORT=3001

# ==========================================
# Management Server parameters (Required for SSO registration)
# ==========================================
MSIP=localhost
ADMIN_EMAIL=admin@apigee.com
APIGEE_ADMINPW=Secret123

# ==========================================
# Machine user for UI
# ==========================================
UI_MACHINE_USER=ui-machine-user@apigee.com
UI_MACHINE_PWD=Secret123

# ==========================================
# Postgres connection parameters
# ==========================================
PG_HOST=postgres_host
PG_USER=apigee
PG_PWD=postgres_password

# ==========================================
# Other UI Parameters
# ==========================================
# Set to sso to enable SSO, default value is basic.
AUTH_MODE=sso

# Y to use internal LDAP for authentication, N to use external IDP
SSO_LOCAL_LDAP=y

MANAGEMENT_UI_APP_ENV=OPDK
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CSRF_SECRET=secret
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

TOA özellikleri dağılımı

Apigee TOA özellikleri aşağıdaki yapılandırma dosyalarına dağıtılır:

  • /opt/silent.conf (veya özel yapılandırma dosyanız): TOA ve yeni Edge kullanıcı arayüzü için temel yapılandırma özelliklerini içerir.
  • /opt/apigee/customer/application/openldap.properties: SAML ve HTTPS gibi isteğe bağlı özellikler için ek TOA yapılandırma özelliklerini içerir.

apigee-openldap bileşenindeki setup-sso komut dosyası, yukarıdaki her iki dosyadan değişkenleri ayrıştırır. Kullanım alanınıza bağlı olarak yapılandırma dosyalarında ilgili özellikleri yapılandırmanız gerekir.

Aşağıdaki adımlar, ortamınıza bağlı olarak isteğe bağlıdır:

Postgres'te TOA veritabanı oluşturma

apigee-postgresql'in çalıştığı düğümde (birincil-yedek kurulumundaki ana düğüm), TOA için bir veritabanı oluşturun:

/opt/apigee/apigee-service/bin/apigee-service apigee-postgresql setup-sso-db

OpenLDAP'ta TOA yapılandırmalarını uygulama

Apigee SSO, dizin bileşenine yerleştirildiğinden bağımsız bir paket yüklemeniz gerekmez. Yapılandırma dosyasını OpenLDAP düğümüne uygulamanız yeterlidir.

Apigee TOA'yı etkinleştirmek ve başlatmak için:
  1. apigee-openldap barındıran düğüme giriş yapın.
  2. Yapılandırma dosyanızı ileterek setup-sso komutunu çalıştırın: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-openldap setup-sso -f /opt/silent.conf

Yeni Edge kullanıcı arayüzünü yapılandırma

Apigee TOA çalışmaya başladıktan sonra, yeni Edge kullanıcı arayüzünü onunla iletişim kuracak şekilde yapılandırmanız gerekir.

Yeni Edge kullanıcı arayüzünde harici bir IdP'yi etkinleştirdikten sonra yeni Edge kullanıcı arayüzü, yönetim sunucusuna bağlanmak için OIDC/OAuth2'yi kullanır. Yeni Edge kullanıcı arayüzü ile Edge Yönetim Sunucusu arasında süresi dolan jetonlar konusunda endişelenmeniz gerekmez. Süresi dolan jetonlar otomatik olarak yenilenir.

  1. Yeni Edge kullanıcı arayüzünü barındıran düğüme giriş yapın.
  2. /opt/silent.conf dosyanızın bu düğümde mevcut olduğundan emin olun.
  3. setup komut dosyasını kullanarak yapılandırmayı uygulayın: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f /opt/silent.conf