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

Private Cloud için Edge v4.18.05

Apigee Developer Services portalı (veya kısaca portal), Apigee Edge istemcisi olarak çalışır. Bu, portalın bağımsız bir sistem olarak çalışmadığı anlamına gelir. Bunun yerine, portal tarafından kullanılan bilgilerin çoğu Edge'de saklanır. Gerektiğinde portal, Edge'den bilgi almak veya Edge'e bilgi göndermek için istek gönderir.

Portal her zaman tek bir Edge kuruluşuyla ilişkilendirilir. Portalı yapılandırırken, portalın Edge ile iletişim kurmak için kullandığı kuruluştaki bir hesabın 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 istek gönderirken SAML kimlik doğrulamasını kullanacak şekilde yapılandırabilirsiniz. Portalı SAML kullanacak şekilde yapılandırdığınızda Edge kuruluşunda otomatik olarak yeni bir makine kullanıcı hesabı oluşturulur. Portal, Edge'e istek göndermek için bu hesabı kullanır. Makine kullanıcıları hakkında daha fazla bilgi için SAML'i otomatik görevlerle kullanma başlıklı makaleyi inceleyin.

Portal için SAML desteği, Edge Yönetim Sunucusu düğümünde Edge TOA modülünü yüklemenizi ve yapılandırmanızı gerektirir. Portal için SAML'i etkinleştirmeyle ilgili genel süreç şu şekildedir:

  1. Edge için SAML'nin kurulumu ve yapılandırılması bölümünde açıklandığı şekilde Edge'de SAML'yi yapılandırın. Not: Portalın yüklenebilmesi için Edge'de Temel Kimlik Doğrulama'nın etkinleştirilmesi gerekir. Portalı SAML kullanacak şekilde yapılandırana kadar Edge'de Temel Kimlik Doğrulama'yı devre dışı bırakmayın.
  2. Portalı yükleyin ve kurulumunuzun düzgün çalıştığından emin olun. Private Cloud için Edge portalını yükleme başlıklı makaleyi inceleyin.
  3. Portalda SAML'yi yapılandırın.
  4. Artık Edge'de Temel Kimlik Doğrulama'yı devre dışı bırakabilirsiniz.

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

SAML etkinleştirildiğinde Edge, makine kullanıcıları kullanılarak otomatik OAuth2 jetonu oluşturmayı destekler. Makine kullanıcıları, şifre kodu belirtmek zorunda kalmadan OAuth2 jetonları alabilir. Bu sayede OAuth2 jetonlarını 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. Portal daha sonra Edge'e bağlanmak için bu makine kullanıcı hesabını kullanır. Makine kullanıcıları hakkında daha fazla bilgi için SAML'i otomatik görevlerle kullanma başlıklı makaleyi inceleyin.

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

Portalı SAML kullanacak şekilde yapılandırdığınızda, portalın Edge'e istek gönderebilmesi için Edge ile kimlik doğrulamak üzere SAML kullanmasını etkinleştirmiş olursunuz. Ancak 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şime geçmek ve uygulama kullanımlarıyla ilgili istatistiksel bilgileri kontrol panelinde görüntülemek için portalı kullanır.

Bir geliştirici portala giriş yaptığında geliştiricinin kimliğini doğrulamaktan ve rol tabanlı izinleri uygulamaktan portal sorumludur. Portal, portal ile Edge arasında SAML'yi etkinleştirdikten sonra bile geliştiricilerle temel kimlik doğrulamayı kullanmaya devam eder. Daha fazla bilgi için Portal ile Edge arasında iletişim kurma başlıklı makaleyi inceleyin.

Portalı, geliştiricilerin kimliğini doğrulamak için SAML kullanacak şekilde de yapılandırabilirsiniz. Üçüncü taraf Drupal modüllerini kullanarak SAML'yi etkinleştirmeyle ilgili bir örnek için Geliştirici Portalı ile SAML üzerinden TOA Entegrasyonu başlıklı makaleyi inceleyin.

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

Portal için SAML'i yapılandırmak üzere portalı yapılandıracak 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şkili kuruluşa Kuruluş Yöneticisi olarak ekleyin.
  2. Portalda SAML'i 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

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

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

    Bu kuruluş SAML özellikli kutusunun işaretli, Edge TOA modülünün uç noktasının doldurulmuş, portal Oauth istemcisi için API anahtarı ve Tüketici gizlisi alanlarının doldurulmuş olduğ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ı istediğiniz zaman yeniden test etmek için 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ırakma

Portal ile Edge arasındaki iletişimler için SAML'yi devre dışı bırakırsanız portal artık Edge'e istek gönderemez. Geliştiriciler portala giriş yapabilir ancak ürün görüntüleyemez veya uygulama oluşturamaz.

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

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