Menginstal dan mengonfigurasi Apigee Apigee

Mulai dari OPDK 4.54.00, arsitektur SSO telah dimodernisasi. Broker identitas (Dex) kini disematkan langsung dalam komponen apigee-openldap, sehingga tidak perlu menginstal modul apigee-sso lama yang terpisah.

Untuk mengaktifkan dan mengonfigurasi Apigee SSO, Anda harus melakukan hal berikut:

  1. Membuat pengguna mesin untuk New Edge UI: Buat pengguna mesin yang diperlukan New Edge UI untuk memanggil API pengelolaan.
  2. Mengonfigurasi properti dalam file konfigurasi umum: Buat satu file konfigurasi yang berisi properti yang diperlukan oleh layanan OpenLDAP (SSO) dan UI Edge Baru.
  3. Membuat database SSO di Postgres: Membuat database untuk SSO di instance PostgreSQL Apigee.
  4. Terapkan konfigurasi SSO di OpenLDAP: Terapkan file konfigurasi untuk memulai Apigee SSO terintegrasi di node OpenLDAP.
  5. Konfigurasi UI Edge Baru: Perbarui properti UI Edge Baru untuk menggunakan Apigee SSO baru.

Setiap langkah ini dijelaskan di bagian berikut.

Membuat pengguna mesin untuk UI

UI Edge baru memerlukan pengguna mesin untuk memanggil API pengelolaan di backend untuk operasi tertentu. Skrip yang telah diinstal sebelumnya di node apigee-openldap digunakan untuk tujuan ini.

Baca selengkapnya tentang skrip dan pengguna mesin di Menggunakan skrip apigee-machine-user.

Gunakan perintah berikut di node apigee-openldap untuk membuat pengguna mesin untuk UI Edge Baru, dan pastikan untuk menggunakan kredensial yang sama persis saat menentukan properti dalam file konfigurasi pada langkah berikutnya. 

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

Mengonfigurasi properti di file konfigurasi umum

Sebelum dapat mengaktifkan Apigee SSO dan New Edge UI, Anda harus menentukan file konfigurasi umum (misalnya, /opt/silent.conf). Anda dapat mengubah jalur dan nama file ini sesuai kebutuhan lingkungan Anda.

Tambahkan properti konfigurasi dasar berikut ke /opt/silent.conf Anda:

# ==========================================
# 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

Distribusi properti SSO

Properti Apigee SSO didistribusikan di seluruh file konfigurasi berikut:

  • /opt/silent.conf (atau file konfigurasi kustom Anda): Berisi properti konfigurasi dasar untuk SSO dan UI Edge Baru.
  • /opt/apigee/customer/application/openldap.properties: Berisi properti konfigurasi SSO tambahan untuk fitur opsional seperti SAML dan HTTPS.

Skrip setup-sso di komponen apigee-openldap mengurai variabel dari kedua file di atas. Bergantung pada kasus penggunaan, Anda perlu mengonfigurasi properti yang relevan dalam file konfigurasi.

Langkah-langkah berikut bersifat opsional, bergantung pada lingkungan Anda:

Membuat database SSO di Postgres

Di node tempat apigee-postgresql berjalan (node master dalam penyiapan primer-standby), buat database untuk SSO:

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

Menerapkan konfigurasi SSO di OpenLDAP

Karena Apigee SSO disematkan dalam komponen direktori, Anda tidak perlu menginstal paket mandiri. Anda cukup menerapkan file konfigurasi ke node OpenLDAP.

Untuk mengaktifkan dan memulai Apigee SSO:
  1. Login ke hosting node apigee-openldap.
  2. Jalankan perintah setup-sso, dengan meneruskan file konfigurasi Anda: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-openldap setup-sso -f /opt/silent.conf

Mengonfigurasi UI New Edge

Setelah Apigee SSO berjalan, Anda harus mengonfigurasi UI Edge Baru untuk berkomunikasi dengannya.

Setelah Anda mengaktifkan IDP eksternal di UI Edge Baru, UI Edge Baru akan menggunakan OIDC/OAuth2 untuk terhubung ke Server Pengelolaan. Anda tidak perlu khawatir tentang token yang habis masa berlakunya antara UI Edge Baru dan Server Pengelolaan Edge. Token yang sudah tidak berlaku akan otomatis diperbarui.

  1. Login ke node yang menghosting UI New Edge.
  2. Pastikan file /opt/silent.conf Anda tersedia di node ini.
  3. Terapkan konfigurasi menggunakan skrip setup: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f /opt/silent.conf