Mengonfigurasi TLS untuk UI Edge baru

Secara default, Anda mengakses UI Edge baru melalui HTTP menggunakan alamat IP atau nama DNS node UI Edge dan port 3001. Contoh:

http://newue_IP:3001

Atau, Anda dapat mengonfigurasi akses TLS ke UI Edge sehingga dapat mengaksesnya dalam formulir:

https://newue_IP:3001

Persyaratan TLS

UI Edge hanya mendukung TLS v1.2. Jika Anda mengaktifkan TLS di UI Edge, pengguna harus terhubung ke UI Edge menggunakan browser yang kompatibel dengan TLS v1.2.

Properti konfigurasi TLS

Jalankan perintah berikut guna mengonfigurasi TLS untuk Edge UI:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

Dengan configFile adalah file konfigurasi yang Anda gunakan untuk menginstal UI Edge.

Sebelum menjalankan perintah ini, Anda harus mengedit file konfigurasi untuk menetapkan properti yang diperlukan yang mengontrol TLS. Tabel berikut menjelaskan properti yang Anda gunakan untuk mengonfigurasi TLS untuk UI Edge:

Properti Deskripsi Wajib diisi?
MANAGEMENT_UI_SCHEME

Menyetel protokol, "http" atau "https", yang digunakan untuk mengakses UI Edge. Nilai defaultnya adalah "http". Setel ke "https" untuk mengaktifkan TLS:

MANAGEMENT_UI_SCHEME=https
Ya
MANAGEMENT_UI_TLS_OFFLOAD

Jika "n", menentukan bahwa permintaan TLS ke UI Edge dihentikan di UI Edge. Anda harus menetapkan MANAGEMENT_UI_TLS_KEY_FILE dan MANAGEMENT_UI_TLS_CERT_FILE.

Jika "y", menentukan bahwa permintaan TLS ke UI Edge dihentikan pada load balancer, dan bahwa load balancer akan meneruskan permintaan ke UI Edge menggunakan HTTP.

Jika Anda menghentikan TLS di load balancer, UI Edge masih perlu mengetahui bahwa permintaan asli masuk melalui TLS. Misalnya, beberapa cookie memiliki tanda Aman yang disetel.

Anda harus menetapkan MANAGEMENT_UI_SCHEME ke "https" atau MANAGEMENT_UI_TLS_OFFLOAD akan diabaikan:

MANAGEMENT_UI_SCHEME=https
MANAGEMENT_UI_TLS_OFFLOAD=y
Ya
MANAGEMENT_UI_TLS_KEY_FILE

MANAGEMENT_UI_TLS_CERT_FILE

Jika MANAGEMENT_UI_TLS_OFFLOAD=n, menentukan jalur absolut ke file sertifikat dan kunci TLS. File harus diformat sebagai file PEM tanpa frasa sandi, dan harus dimiliki oleh pengguna "apigee".

Lokasi yang direkomendasikan untuk file ini adalah:

/opt/apigee/customer/application/edge-management-ui

Jika direktori tersebut tidak ada, buatlah direktori.

Jika MANAGEMENT_UI_TLS_OFFLOAD=y, maka abaikan MANAGEMENT_UI_TLS_KEY_FILE dan MANAGEMENT_UI_TLS_CERT_FILE.. Permintaan akan diabaikan karena permintaan ke UI Edge masuk melalui HTTP.

Ya jika MANAGEMENT_UI_TLS_OFFLOAD=n
MANAGEMENT_UI_PUBLIC_URIS

Jika MANAGEMENT_UI_TLS_OFFLOAD=n, menentukan URL UI Edge.

Tetapkan properti ini berdasarkan properti lain dalam file konfigurasi. Contoh:

MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT

Dengan keterangan:

  • MANAGEMENT_UI_SCHEME menentukan protokol, "http" atau "https", seperti yang dijelaskan di atas.
  • MANAGEMENT_UI_IP menentukan alamat IP atau nama DNS di UI Edge.
  • MANAGEMENT_UI_PORT menentukan port yang digunakan oleh UI Edge.

Lihat Menginstal UI Edge baru untuk mengetahui informasi selengkapnya tentang properti ini.

Jika MANAGEMENT_UI_TLS_OFFLOAD=y:

  • MANAGEMENT_UI_IP menentukan alamat IP atau nama DNS load balancer, bukan UI Edge.
  • Load balancer dan UE Baru harus menggunakan nomor port yang sama untuk permintaan, misalnya 3001. Gunakan MANAGEMENT_UI_PORT untuk menentukan nomor port pada load balancer dan di UE Baru.

Ya

MANAGEMENT_UI_TLS_ALLOWED_CIPHERS

Menentukan daftar cipher TLS yang tersedia sebagai string yang dipisahkan koma atau dipisahkan spasi.

String yang dipisahkan koma:

MANAGEMENT_UI_TLS_ALLOWED_CIPHERS=TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

String yang dipisahkan spasi dan diapit dalam tanda kutip ganda:

MANAGEMENT_UI_TLS_ALLOWED_CIPHERS="TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"

SHOEHORN_SCHEME

Sebelum Menginstal UI Edge baru, Anda harus menginstal UI Edge dasar yang disebut shoehorn terlebih dahulu. File konfigurasi penginstalan menggunakan properti berikut untuk menentukan protokol, "http", yang digunakan untuk mengakses UI Edge dasar:

SHOEHORN_SCHEME=http

UI Edge dasar tidak mendukung TLS, jadi meskipun Anda mengaktifkan TLS di UI Edge, properti ini tetap harus disetel ke "http".

Ya dan tetapkan ke "http"

Mengonfigurasi TLS

Untuk mengonfigurasi akses TLS ke Edge UI:

  1. Buat sertifikat dan kunci TLS sebagai file PEM tanpa frasa sandi. Contoh:

    mykey.pem
    mycert.pem

    Ada banyak cara untuk membuat sertifikat dan kunci TLS. Misalnya, Anda dapat menjalankan perintah berikut untuk membuat sertifikat dan kunci yang tidak ditandatangani:

    openssl req -x509 -newkey rsa:4096 -keyout mykey.pem -out mycert.pem -days 365 -nodes -subj '/CN=localhost'
  2. Salin file kunci dan sertifikat ke direktori /opt/apigee/customer/application/edge-management-ui. Jika direktori tersebut tidak ada, buatlah direktori.
  3. Pastikan sertifikat dan kunci dimiliki oleh pengguna "apigee":

    chown apigee:apigee /opt/apigee/customer/application/edge-management-ui/*.pem
  4. Edit file konfigurasi yang Anda gunakan untuk menginstal UI Edge untuk menetapkan properti TLS berikut:

    # Set to https to enable TLS.
    MANAGEMENT_UI_SCHEME=https 
    # Do NOT terminate TLS on a load balancer.
    MANAGEMENT_UI_TLS_OFFLOAD=n
    
    # Specify the key and cert. 
    MANAGEMENT_UI_TLS_KEY_FILE=/opt/apigee/customer/application/edge-management-ui/mykey.pem
    MANAGEMENT_UI_TLS_CERT_FILE=/opt/apigee/customer/application/edge-management-ui/mycert.pem
    
    # Leave these properties set to the same values as when you installed the Edge UI:
    MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
    SHOEHORN_SCHEME=http
  5. Jalankan perintah berikut untuk mengonfigurasi TLS:

    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

    Dengan configFile adalah nama file konfigurasi.

    Skrip akan memulai ulang UI Edge.

  6. Jalankan perintah berikut untuk menyiapkan dan memulai ulang shoehorn:

    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

    Setelah mulai ulang, UI Edge mendukung akses melalui HTTPS. Jika Anda tidak dapat login ke UI Edge setelah mengaktifkan TLS, hapus cache browser dan coba login lagi.

Mengonfigurasi UI Edge saat TLS dihentikan di load balancer

Jika Anda memiliki load balancer yang meneruskan permintaan ke UI Edge, Anda dapat memilih untuk menghentikan koneksi TLS di load balancer, lalu meminta load balancer meneruskan permintaan ke UI Edge melalui HTTP:

Menghentikan TLS di load balancer

Konfigurasi ini didukung, tetapi Anda perlu mengonfigurasi load balancer dan UI Edge yang sesuai.

Untuk mengonfigurasi UI Edge saat TLS dihentikan di load balancer:

  1. Edit file konfigurasi yang Anda gunakan untuk menginstal UI Edge untuk menetapkan properti TLS berikut:

    # Set to https to enable TLS
    MANAGEMENT_UI_SCHEME=https
    # Terminate TLS on a load balancer
    MANAGEMENT_UI_TLS_OFFLOAD=y
    # Set to the IP address or DNS name of the load balancer.
    MANAGEMENT_UI_IP=LB_IP_DNS
    # Set to the port number for the load balancer and Edge UI.
    # The load balancer and the Edge UI must use the same port number.
    MANAGEMENT_UI_IP=3001
    
    # Leave these properties set to the same values as when you installed the Edge UI:
    MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
    SHOEHORN_SCHEME=http
    

    Jika Anda menyetel MANAGEMENT_UI_TLS_OFFLOAD=y, hapus MANAGEMENT_UI_TLS_KEY_FILE dan MANAGEMENT_UI_TLS_CERT_FILE.. Permintaan ke UI Edge akan diabaikan karena permintaan ke UI Edge masuk melalui HTTP.

  2. Jalankan perintah berikut untuk mengonfigurasi TLS:

    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

    Dengan configFile adalah nama file konfigurasi.

    Skrip akan memulai ulang UI Edge.

  3. Jalankan perintah berikut untuk menyiapkan dan memulai ulang shoehorn:

    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

    Setelah mulai ulang, UI Edge mendukung akses melalui HTTPS. Jika Anda tidak dapat login ke UI Edge setelah mengaktifkan TLS, hapus cache browser dan coba login lagi.

Nonaktifkan TLS di Edge UI

Untuk menonaktifkan TLS di Edge UI:

  1. Edit file konfigurasi yang Anda gunakan untuk menginstal UI Edge untuk menyetel properti TLS berikut:

    # Set to http to disable TLS.
    MANAGEMENT_UI_SCHEME=http
    
    # Only if you had terminated TLS on a load balancer,
    # reset to the IP address or DNS name of the Edge UI.
    MANAGEMENT_UI_IP=newue_IP_DNS
    
  2. Jalankan perintah berikut untuk menonaktifkan TLS:

    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-ssl -f configFile

    Dengan configFile adalah nama file konfigurasi.

    Skrip akan memulai ulang UI Edge.

  3. Jalankan perintah berikut untuk menyiapkan dan memulai ulang shoehorn:

    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

    Anda kini dapat mengakses UI Edge melalui HTTP. Jika Anda tidak dapat login ke UI Edge setelah menonaktifkan TLS, hapus cache browser dan coba login lagi.