Mengonfigurasi host virtual untuk Private Cloud

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Dengan penginstalan lokal, Anda memiliki kontrol penuh atas host virtual. Anda dapat membuat host virtual untuk organisasi apa pun, di lingkungan apa pun, menggunakan TLS atau tidak.

Dokumen ini menjelaskan cara membuat host virtual sederhana. Artinya, yang tidak mendukung TLS. Untuk contoh lainnya, termasuk contoh cara membuat host virtual yang mendukung TLS, lihat Mengonfigurasi akses TLS ke API untuk Cloud Pribadi.

Pelajari lebih lanjut:

Tentang alias host

Saat membuat host virtual, Anda harus menentukan alias host virtual. Biasanya ini adalah nama DNS host virtual.

Edge Router membandingkan header Host permintaan masuk dengan daftar alias host yang tersedia sebagai bagian dari penentuan proxy API yang menangani permintaan. Saat membuat permintaan melalui host virtual, tentukan nama domain yang cocok dengan alias host virtual, atau tentukan alamat IP Router dan header Host yang berisi alias host.

Misalnya, jika Anda membuat host virtual dengan alias host myapis.apigee.net di port 9001, permintaan cURL ke API melalui host virtual tersebut dapat menggunakan salah satu bentuk berikut:

  • Jika Anda memiliki entri DNS untuk myapis.apigee.net:

    curl http://myapis.apigee.net:9001/proxy-base-path/resource-path
  • Jika Anda tidak memiliki entri DNS untuk myapis.apigee.net:

    curl http://routerIP:9001/proxy-base-path/resource-path -H 'host:myapis.apigee.net'

    Dalam formulir ini, Anda menentukan alamat IP Router, dan meneruskan alias host di header Host.

    curl http://routerIP:9001/proxy-base-path/resource-path

Opsi saat Anda tidak memiliki entri DNS untuk host virtual

Salah satu opsi jika Anda tidak memiliki entri DNS adalah menetapkan alias host ke alamat IP Router dan port host virtual, seperti routerIP:port. Misalnya:

192.168.1.31:9001

Saat Anda membuat perintah curl dalam formulir di bawah:

curl http://routerIP:9001/proxy-base-path/resource-path

Opsi ini lebih disukai karena berfungsi dengan baik dengan UI Edge.

Jika Anda memiliki beberapa Router, tambahkan alias host untuk setiap Router, yang menentukan alamat IP setiap Router dan port host virtual.

Atau, Anda dapat menetapkan alias host ke nilai, seperti temp.hostalias.com. Kemudian, Anda harus meneruskan header Host pada setiap permintaan:

curl -v http://routerIP:9001/proxy-base-path/resource-path -H 'Host: temp.hostalias.com'

Atau, tambahkan alias host ke file /etc/hosts. Misalnya, tambahkan baris ini ke /etc/hosts:

192.168.1.31 temp.hostalias.com

Kemudian, Anda dapat membuat permintaan seolah-olah memiliki entri DNS:

curl -v http://myapis.apigee.net:9001/proxy-base-path/resource-path

Tentang port host virtual di Edge untuk Private Cloud 4.16.01 dan yang lebih baru

Saat membuat host virtual, Anda menentukan port Router yang digunakan oleh host virtual. Misalnya, port 9001.

Untuk rilis Apigee for Private Cloud 4.16.01 dan yang lebih baru, secara default, Router berjalan sebagai pengguna "apigee" yang tidak memiliki akses ke port dengan hak istimewa, biasanya port 1024 dan yang lebih rendah. Jika ingin membuat host virtual yang mengikat Router ke port yang dilindungi, Anda harus mengonfigurasi Router agar berjalan sebagai pengguna yang memiliki akses ke port tersebut. Lihat Menyiapkan host virtual untuk mengetahui informasi selengkapnya.

Membuat host virtual

Bagian ini menjelaskan cara membuat host virtual untuk Apigee Edge untuk Private Cloud. Perhatikan bahwa untuk membuat host virtual baru, Anda harus menjadi administrator organisasi.

Anda dapat membuat host virtual untuk Apigee Edge untuk Cloud Pribadi menggunakan API atau UI Edge. Hal ini dijelaskan di bagian berikut.

Membuat host virtual menggunakan browser

Bagian ini menjelaskan cara membuat host virtual menggunakan browser (khusus UI Edge).

Untuk membuat host virtual baru di UI Edge:

  1. Login ke UI pengelolaan Edge.
  2. Pilih Admin > Virtual Hosts.
  3. Pilih lingkungan dari menu drop-down.

    Edge menampilkan daftar host virtual untuk lingkungan tersebut.

  4. Untuk membuat host virtual baru, pilih + Host Virtual.

    Edge akan menampilkan formulir Create Virtual Host.

    Anda juga dapat mengklik nama host virtual yang ada untuk mengeditnya.

  5. Tentukan host virtual baru Anda. Perhatikan bahwa kolom URL Dasar harus menyertakan protokol (yaitu, beri awalan nilai kolom dengan "http://" atau "https://".)

    Selain itu, perhatikan bahwa:

    • Tidak ada batasan jumlah host virtual yang dapat Anda buat
    • TLS bersifat opsional, dan dapat berupa versi 1.0, 1.1, atau 1.2
    • Port host virtual dapat dikonfigurasi
  6. Klik tombol Create untuk menyimpan host virtual baru.

Membuat host virtual dengan API

Untuk membuat host virtual dengan API, buat objek XML yang menentukan host virtual. Misalnya, objek XML berikut menentukan host virtual yang menggunakan protokol HTTP:

<VirtualHost name="myVHost">
   <HostAliases>
     <HostAlias>DNS_name_or_IP:port</HostAlias>
   </HostAliases>
   <Interfaces/>
   <Port>9005</Port>
</VirtualHost>

Perhatikan bahwa host virtual berisi properti name. Anda menggunakan nilai properti name untuk mengonfigurasi proxy API agar dapat menggunakan host virtual.

Kemudian, Anda dapat mengakses proxy API melalui host virtual ini dengan membuat permintaan ke:

http://routerIP:port/proxy-base-path/resource-path
https://routerIP:port/proxy-base-path/resource-path

Dengan keterangan:

  • http atau https: Jika host virtual dikonfigurasi untuk mendukung TLS, gunakan HTTPS. Jika host virtual tidak mendukung TLS, gunakan HTTP.
  • routerIP:port adalah alamat IP dan nomor port host virtual.
  • proxy-base-path dan resource-path ditentukan saat Anda membuat proxy API.

Biasanya, Anda tidak memublikasikan API kepada pelanggan dengan alamat IP dan nomor port. Sebagai gantinya, Anda menentukan entri DNS untuk Router dan port. Contoh:

http://api.myCompany.com/proxy-base-path/resource-path
https://api.myCompany.com/proxy-base-path/resource-path

Jika menentukan entri DNS, Anda harus membuat alias host untuk host virtual yang cocok dengan nama domain entri DNS. Alias host harus cocok dengan string yang diteruskan klien di header Host. Dari contoh di atas, Anda akan menentukan alias host api.myCompany.com.

<VirtualHost name="myVHost">
    <HostAliases>
        <HostAlias>api.myCompany.com</HostAlias>
    </HostAliases>
    <Interfaces/>
    <Port>9005</Port>
</VirtualHost>

Untuk membuat host virtual yang menggunakan protokol HTTP, lakukan hal berikut:

  1. Buat host virtual dengan menggunakan Create a Virtual Host API, dengan ms-IP sebagai alamat IP atau nama domain node Management Server:
    $ curl -X POST -H "Content-Type:application/xml" \
    http://ms-IP:8080/v1/o/org_name/environments/env_name/virtualhosts \
    -d '<VirtualHost name="newVHost">
        <HostAliases>
          <HostAlias>api.myCompany.com</HostAlias>
        </HostAliases>
        <Interfaces/>
        <Port>9005</Port>
      </VirtualHost>' \
    -u sysAdminEmail:password
    
  2. Buat data DNS untuk host virtual yang cocok dengan alias host.
  3. Jika Anda memiliki proxy API yang sudah ada, tambahkan host virtual ke elemen <HTTPConnection> di Endpoint Proxy. Host virtual ditambahkan secara otomatis ke semua proxy API baru. Lihat Mengonfigurasi proxy API untuk menggunakan host virtual.

Mengubah host virtual

Untuk mengubah host virtual, lakukan tindakan berikut:

  1. Update host virtual menggunakan Update a Virtual Host API, dengan <ms-IP> adalah alamat IP atau nama domain dari node Server Pengelolaan. Anda harus menentukan definisi lengkap host virtual dalam isi permintaan, bukan hanya elemen yang ingin diubah. Dalam contoh ini, Anda mengubah nomor port host virtual dari 9008 menjadi 9009:

    curl -X PUT -H "Content-Type:application/xml" \
      http://ms-IP:8080/v1/o/org_name/environments/env_name/virtualhosts/vhost_name \
      -d '<VirtualHost name="newVHost">
        <HostAliases>
          <HostAlias>api.myCompany.com</HostAlias>
        </HostAliases>
        <Interfaces/>
        <Port>9009</Port>
      </VirtualHost>' \
      -u email:password
  2. Khusus Edge for Private Cloud versi 4.16.01 dan 4.16.05, Jika Anda mengubah host virtual yang ada, dan Anda mengaktifkan TLS atau menonaktifkan TLS tanpa mengubah nomor port, maka:
    1. Hentikan Router:

      /opt/apigee/apigee-service/bin/apigee-service edge-router stop
    2. Hapus semua file di /opt/nginx/conf.d:

      rm -f /opt/nginx/conf.d/*
    3. Mulai Router:

      /opt/apigee/apigee-service/bin/apigee-service edge-router start
    4. Ulangi untuk semua Router.