Edge ile iletişim kurmak için SAML'yi kullanmak üzere portalı yapılandırma

Edge for Private Cloud 4.19.01 sürümü

Apigee Developer Services portalı (veya daha basit bir şekilde ifade etmek gerekirse portal), Apigee Edge'in müşterisidir. Bu durum, portalın bağımsız bir sistem olarak çalışmadığı anlamına gelir. Bunun yerine portal tarafından kullanılan bilgilerin çoğu aslında Edge'de depolanıyor. Portal, gerektiğinde Edge'den bilgi almak veya Edge'e bilgi göndermek için istekte bulunur.

Portal her zaman tek bir Edge kuruluşuyla ilişkilendirilir. Portalı yapılandırırken, kuruluştaki bir hesabın Edge ile iletişim kurmak için kullandığı temel kimlik doğrulama kimlik bilgilerini (kullanıcı adı ve şifre) belirtebilirsiniz.

Edge kimlik doğrulaması için SAML'yi etkinleştirmeyi seçerseniz portalı, Edge'e istekte bulunurken SAML kimlik doğrulamasını kullanacak şekilde yapılandırabilirsiniz. Portalın SAML'yi kullanacak şekilde yapılandırılması, Edge kuruluşunda otomatik olarak yeni bir makine kullanıcısı hesabı oluşturur. Portalı bu hesap Edge'e istekte bulunmak için kullanılır. Makine kullanıcıları hakkında daha fazla bilgi için SAML'yi otomatik görevlerle kullanma başlıklı makaleye bakın.

Portalın SAML desteği için Edge Yönetim Sunucusu düğümüne Edge TOA modülünü önceden yüklemiş ve yapılandırmış olmanız gerekir. Portalda SAML'yi etkinleştirmeyle ilgili genel süreç şu şekildedir:

  1. Edge'de SAML'yi Edge için SAML'yi yükleme ve yapılandırma bölümünde açıklandığı şekilde yapılandırın. Not: Portalı yüklemek için Edge'de Temel Kimlik Doğrulama hâlâ etkinleştirilmiş olmalıdır. Portalı SAML'yi kullanacak şekilde yapılandırana kadar Edge'de Temel Kimlik Doğrulama'yı devre dışı bırakmayın.
  2. Portalı yükleyin ve yüklemenizin düzgün çalıştığından emin olun. Private Cloud portalı için Edge'i yükleme bölümüne bakın.
  3. Portalda SAML'yi yapılandırın.
  4. Artık Edge'de Basic Auth'u devre dışı bırakabilirsiniz.

Portal için makine kullanıcısı oluşturma

SAML etkinleştirildiğinde Edge, makine kullanıcılarının kullanımı aracılığıyla otomatik OAuth2 jetonu oluşturmayı destekler. Makine kullanıcıları, şifre kodu belirtmek zorunda kalmadan OAuth2 jetonları alabilir. Bu sayede, OAuth2 jetonları alma ve yenileme işlemini tamamen otomatikleştirebilirsiniz.

Portalın SAML yapılandırma işlemi, portalla ilişkili kuruluşta otomatik olarak bir makine kullanıcısı oluşturur. Daha sonra portal, Edge'e bağlanmak için bu makine kullanıcısı hesabını kullanır. Makine kullanıcıları hakkında daha fazla bilgi için SAML'yi otomatik görevlerle kullanma başlıklı makaleye bakın.

Portal geliştirici hesapları için kimlik doğrulama hakkında

Portalı SAML'yi kullanacak şekilde yapılandırdığınızda, portalın Edge'e istek gönderebilmesi için portalın Edge ile kimlik doğrulaması gerçekleştirmek üzere SAML'yi kullanmasına izin verirsiniz. Bununla birlikte, portal geliştiriciler adlı bir kullanıcı türünü de destekler.

Geliştiriciler, API'lerinizi kullanarak uygulama oluşturan kullanıcı topluluğunu oluşturur. Uygulama geliştiriciler API'leriniz hakkında bilgi edinmek, API'lerinizi kullanan uygulamaları kaydetmek, geliştirici topluluğuyla etkileşimde bulunmak ve uygulama kullanımlarıyla ilgili istatistiksel bilgileri bir kontrol panelinde görüntülemek için portalı kullanırlar.

Bir geliştirici portala giriş yaptığında geliştiricinin kimliğini doğrulamak ve rol tabanlı izinleri zorunlu kılmak sorumlu olan portaldır. Portal, portal ile Edge arasında SAML'yi etkinleştirmenizden sonra bile geliştiricilerle temel kimlik doğrulamasını kullanmaya devam eder. Daha fazla bilgi için Portal ile Edge arasında iletişim kurma konusuna bakın.

Portalı, geliştiricilerin kimliğini doğrulamak için SAML kullanacak şekilde yapılandırmak da mümkündür. Üçüncü taraf Drupal modüllerini kullanarak SAML'yi etkinleştirmeyle ilgili bir örnek için Developer Portal ile SAML üzerinden TOA Entegrasyonu bölümüne bakın.

Edge ile iletişim kurmak için portalda SAML'yi yapılandırın

Portal için SAML'yi yapılandırmak üzere, portalı yapılandırmak için bir yapılandırma dosyası oluşturmanız gerekir:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on apigee-sso.
SSO_PUBLIC_URL_SCHEME=http

# SSO admin credentials as set when you installed apigee-sso.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
PORTALCLI_SSO_CLIENT_NAME=portalcli
# Oauth client password using uppercase, lowercase, number, and special chars. 
PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1

# Email address and user info for the machine user created in 
# the Edge org specified above by EDGE_ORG. 
# This account is used by the portal to make requests to Edge.
# Add this email as an org admin before configuring the portal to use SAML. 
DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com
DEVPORTAL_ADMIN_FIRSTNAME=DevPortal
DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin
DEVPORTAL_ADMIN_PWD=Abcdefg@1

# If set, the existing portal OAuth client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

Portalda SAML desteğini etkinleştirmek için:

  1. Edge kullanıcı arayüzünde, DEVPORTAL_ADMIN_EMAIL tarafından belirtilen makine kullanıcısını portalla ilişkilendirilen kuruluşa Kuruluş Yöneticisi olarak ekleyin.
  2. Portalda SAML'yi yapılandırmak için aşağıdaki komutu çalıştırın: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    samlConfigFile, SAML yapılandırma dosyasıdır.

  3. Portala portal yöneticisi olarak giriş yapın.
  4. Ana Drupal menüsünde Yapılandırma > Geliştirici Portalı'nı seçin. SAML ayarlarını da içeren portal yapılandırma ekranı görüntülenir:

    Bu kuruluş SAML özellikli kutusunun işaretli olduğunu, Edge TOA modülünün uç noktasının doldurulduğunu, Oauth istemcisi portalına ait API anahtarı ve Tüketici gizli anahtarı alanlarının doldurulduğunu ve Bağlantıyı Test Et düğmesinin altında Bağlantı Başarılı mesajının göründüğünü unutmayın.

  5. Bağlantıyı yeniden test etmek için istediğiniz zaman Bağlantıyı Test Et düğmesine basabilirsiniz.

Bu değerleri daha sonra değiştirmek için yapılandırma dosyasını güncelleyin ve komutu tekrar çalıştırın.

Portalda SAML'yi devre dışı bırakın

Portal ile Edge arasındaki iletişim için SAML'yi devre dışı bırakmayı seçerseniz portal artık Edge'e istek yapamaz. Geliştiriciler portala giriş yapabilir ancak ürünü görüntüleyemez veya uygulama oluşturamazlar.

Portalda SAML'yi devre dışı bırakmak için:

  1. SAM'yi yapılandırmak için kullandığınız yapılandırma dosyasını şu şekilde düzenleyin: 
    DEVPORTAL_SSO_ENABLED=n
  2. Portalı yapılandırın: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile