Uzaktan Önbelleğe Alma

Sorun bildirme Kaynağı görüntüleme Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bu sayfada uzak önbelleğe alma, önbelleği barındıracak bir sunucu oluşturma ve uzak önbelleği kullanarak derleme çalıştırma konuları ele alınmaktadır.

Uzak önbelleğe alma, geliştirici ekibi ve/veya sürekli entegrasyon (CI) sistemi tarafından derleme sonuçlarını paylaşmak için kullanılır. Derlemeniz yeniden oluşturulabilirse bir makineden elde edilen çıkışlar başka bir makinede güvenli bir şekilde yeniden kullanılabilir. Bu da derlemeleri önemli ölçüde hızlandırabilir.

Genel Bakış

Bazel, derlemeyi işlem adı verilen ayrı adımlara ayırır. Her işlemin girişleri, çıkış adları, komut satırı ve ortam değişkenleri vardır. Zorunlu girişler ve beklenen çıkışlar her işlem için açıkça belirtilir.

Bir sunucuyu, derleme çıkışları olan uzak önbellek (bu işlem çıkışları) için ayarlayabilirsiniz. Bu çıkışlar, çıkış dosyası adlarının ve içeriklerinin karmalarından oluşan bir listeden oluşur. Uzak önbelleği kullanarak, her yeni çıktıyı yerel olarak derlemek yerine başka bir kullanıcının derlemesinden gelen derleme çıktılarını yeniden kullanabilirsiniz.

Uzaktan önbelleğe almayı kullanmak için:

  • Önbelleğin arka ucu olarak bir sunucu ayarlama
  • Bazel derlemesini uzak önbelleği kullanacak şekilde yapılandırma
  • Bazel 0.10.0 veya sonraki bir sürümü kullanın

Uzak önbellek iki tür veri depolar:

  • İşlem karmalarının işlem sonucu meta verileriyle eşlendiği bir harita olan işlem önbelleği.
  • Çıkış dosyalarının içeriğiyle ilgili adreslenebilir bir depo (CAS).

Uzaktan önbelleğin her işlem için stdout ve stderr'yi de depoladığını unutmayın. Bu nedenle, Bazel'in stdout/stderr değerini incelemek önbelleğe isabet sayısını tahmin etmek için iyi bir sinyal değildir.

Derlemelerde uzak önbelleğe alma nasıl kullanılır?

Uzak önbellek olarak ayarlanan bir sunucuyu birden fazla şekilde kullanabilirsiniz:

  • Uzak önbelleği okuma ve yazma
  • Belirli hedefler hariç uzak önbelleğe okuma ve/veya yazma
  • Yalnızca uzak önbellekten oku
  • Uzak önbelleği hiç kullanma

Uzaktan önbelleğe okuma ve yazma yapabilen bir Bazel derlemesi çalıştırdığınızda derleme aşağıdaki adımları uygular:

  1. Bazel, oluşturulması gereken hedeflerin grafiğini ve ardından gerekli işlemlerin listesini oluşturur. Bu işlemlerin her biri için giriş ve çıkış dosya adları belirtilmiştir.
  2. Bazel, yerel makinenizde mevcut derleme çıkışlarını kontrol eder ve bulduğu çıkışları yeniden kullanır.
  3. Bazel, mevcut derleme çıkışları için önbelleği kontrol eder. Sonuç bulunursa Bazel sonucu alır. Bu bir önbellek isabetidir.
  4. Çıkışların bulunamadığı gerekli işlemler için Bazel, işlemleri yerel olarak yürütür ve gerekli derleme çıkışlarını oluşturur.
  5. Yeni derleme çıkışları, uzak önbelleğe yüklenir.

Önbelleğin arka ucu olarak sunucu ayarlama

Önbelleğin arka ucu olarak kullanılacak bir sunucu oluşturmanız gerekir. HTTP/1.1 sunucusu, Bazel'in verilerini opak baytlar olarak işleyebilir. Bu nedenle, birçok mevcut sunucu uzak önbelleğe alma arka ucu olarak kullanılabilir. Uzak önbelleğe almayı destekleyen Bazel'in HTTP Önbelleğe Alma Protokolü'dür.

Önbelleğe alınan çıkışları depolayacak arka uç sunucusunu seçmek, ayarlamak ve sürdürmekten siz sorumlusunuzdur. Sunucu seçerken şunları göz önünde bulundurun:

  • Ağ hızı. Örneğin, ekibiniz aynı ofisteyse kendi yerel sunucunuzu çalıştırmak isteyebilirsiniz.
  • Güvenlik. Uzak önbellekte ikili dosyalarınız bulunur ve bu nedenle güvenli olmaları gerekir.
  • Kolay yönetim. Örneğin, Google Cloud Storage tümüyle yönetilen bir hizmettir.

Uzak önbellek için kullanılabilecek birçok arka uç vardır. Bazı seçenekler şunlardır:

nginx

nginx, açık kaynak bir web sunucusudur. [WebDAV modülü] ile Bazel için uzak önbellek olarak kullanılabilir. Debian ve Ubuntu'da nginx-extras paketini yükleyebilirsiniz. macOS'te nginx, Homebrew üzerinden kullanılabilir:

brew tap denji/nginx
brew install nginx-full --with-webdav

Aşağıda, nginx için örnek bir yapılandırma verilmiştir. /path/to/cache/dir değerini, nginx'in yazma ve okuma iznine sahip olduğu geçerli bir dizinle değiştirmeniz gerektiğini unutmayın. Daha büyük çıkış dosyalarınız varsa client_max_body_size seçeneğini daha büyük bir değerle değiştirmeniz gerekebilir. Sunucu, kimlik doğrulama gibi başka bir yapılandırmaya gerekir.

nginx.conf'daki server bölümü için örnek yapılandırma:

location /cache/ {
  # The path to the directory where nginx should store the cache contents.
  root /path/to/cache/dir;
  # Allow PUT
  dav_methods PUT;
  # Allow nginx to create the /ac and /cas subdirectories.
  create_full_put_path on;
  # The maximum size of a single file.
  client_max_body_size 1G;
  allow all;
}

bazel-uzaktan

bazel-remote, altyapınızda kullanabileceğiniz açık kaynaklı bir uzak derleme önbelleğidir. 2018'in başlarından bu yana çeşitli şirketlerde üretimde başarıyla kullanılmaktadır. Bazel projesinin bazel-remote için teknik destek sağlamadığını unutmayın.

Bu önbellek, içeriği diskte depolar ve üst depolama sınırını uygulamak ve kullanılmayan yapıları temizlemek için çöp toplama işlemi de sağlar. Önbellek [docker görüntüsü] olarak ve kodu GitHub'da mevcuttur. Hem REST hem de gRPC uzak önbellek API'leri desteklenir.

Bu SDK'yı nasıl kullanacağınızla ilgili talimatlar için GitHub sayfasına bakın.

Google Cloud Storage

[Google Cloud Storage], Bazel'in uzaktan önbelleğe alma protokolüyle uyumlu olan bir HTTP API sağlayan, tümüyle yönetilen bir nesne deposudur. Bunun için faturalandırmanın etkin olduğu bir Google Cloud hesabınız olmalıdır.

Cloud Storage'ı önbellek olarak kullanmak için:

  1. Storage paketi oluşturun. Ağ bant genişliği, uzak önbellek için önemli olduğundan size en yakın paket konumunu seçtiğinizden emin olun.

  2. Cloud Storage'da kimlik doğrulaması yapmak üzere Bazel için bir hizmet hesabı oluşturun. Hizmet hesabı oluşturma sayfasına göz atın.

  3. Gizli bir JSON anahtarı oluşturun ve ardından kimlik doğrulaması için Bazel'e iletin. Anahtara sahip herkes GCS paketinize rastgele veri okuyup yazabileceğinden anahtarı güvenli bir şekilde depolayın.

  4. Bazel komutunuza aşağıdaki işaretçileri ekleyerek Cloud Storage'a bağlanın:

    • İşareti kullanarak şu URL'yi Bazel'a iletin: --remote_cache=https://storage.googleapis.com/bucket-name, burada bucket-name, depolama paketinizin adıdır.
    • Şu işareti kullanarak kimlik doğrulama anahtarını iletin: --google_credentials=/path/to/your/secret-key.json veya Uygulama Kimlik Doğrulaması'nı kullanmak için --google_default_credentials.

  5. Cloud Storage'ı eski dosyaları otomatik olarak silecek şekilde yapılandırabilirsiniz. Bunu yapmak için Nesne Yaşam Döngülerini Yönetme bölümünü inceleyin.

Diğer sunucular

Önbelleğin arka ucu olarak PUT ve GET'yi destekleyen herhangi bir HTTP/1.1 sunucusu oluşturabilirsiniz. Kullanıcılar; Hazelcast, Apache httpd ve AWS S3 gibi önbelleğe alma arka uçlarının başarılı olduğunu bildirmiştir.

Kimlik doğrulama

0.11.0 sürümünden itibaren Bazel'e HTTP Temel Kimlik Doğrulaması için destek eklendi. Uzak önbellek URL'si aracılığıyla Bazel'a bir kullanıcı adı ve şifre aktarabilirsiniz. Söz dizimi https://username:password@hostname.com:port/path. HTTP Temel Kimlik Doğrulaması'nın, kullanıcı adını ve şifreyi ağ üzerinden düz metin olarak ilettiğini ve bu nedenle her zaman HTTPS ile kullanılmasının kritik olduğunu unutmayın.

HTTP önbelleğe alma protokolü

Bazel, HTTP/1.1 üzerinden uzaktan önbelleğe almayı destekler. Protokol kavramsal olarak basittir: İkili veriler (BLOB) PUT istekleri aracılığıyla yüklenir ve GET istekleri aracılığıyla indirilir. İşlem sonucu meta verileri /ac/ altında, çıkış dosyaları ise /cas/ altında depolanır.

Örneğin, http://localhost:8080/cache altında çalışan bir uzak önbelleği düşünün. SHA256 karması 01ba4719... olan bir işlem için işlem sonucu meta verilerini indirme Bazel isteği aşağıdaki gibi görünür:

GET /cache/ac/01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b HTTP/1.1
Host: localhost:8080
Accept: */*
Connection: Keep-Alive

CAS'ye 15e2b0d3... SHA256 karmasına sahip çıkış dosyası yüklemeyle ilgili bir Bazel isteği aşağıdaki gibi görünür:

PUT /cache/cas/15e2b0d3c33891ebb0f1ef609ec419420c20e320ce94c65fbc8c3312448eb225 HTTP/1.1
Host: localhost:8080
Accept: */*
Content-Length: 9
Connection: Keep-Alive

0x310x320x330x340x350x360x370x380x39

Bazel'i uzak önbelleği kullanarak çalıştırma

Bir sunucu uzak önbellek olarak ayarlandıktan sonra uzak önbelleği kullanmak için Bazel komutunuza bayrak eklemeniz gerekir. Yapılandırma listesini ve işaretlemelerini aşağıda bulabilirsiniz.

Seçtiğiniz sunucuya özel olan kimlik doğrulamayı da yapılandırmanız gerekebilir.

Bazel'i her çalıştırdığınızda belirtmeniz gerekmemesi için bu işaretleri bir .bazelrc dosyasına ekleyebilirsiniz. Projenize ve ekip dinamiklerinize bağlı olarak, aşağıdaki özelliklere sahip bir .bazelrc dosyasına işaret ekleyebilirsiniz:

  • Yerel makinenizde
  • Projenizin çalışma alanında, ekiple paylaşılan
  • CI sisteminde

Uzak önbellekten veri okuma ve önbelleğe veri yazma

Uzaktan önbelleğe yazma yetkisi olan kişilere dikkat edin. Uzak önbelleğe yalnızca CI sisteminizin yazabilmesini isteyebilirsiniz.

Uzak önbellekten okumak ve yazmak için aşağıdaki işareti kullanın:

build --remote_cache=http://your.host:port

HTTP'ün yanı sıra aşağıdaki protokoller de desteklenir: HTTPS, grpc, grpcs.

Yalnızca uzak önbellekten okumak için yukarıdakine ek olarak aşağıdaki işareti kullanın:

build --remote_upload_local_results=false

Belirli hedefleri uzak önbellekten hariç tutun

Belirli hedeflerin uzak önbelleği kullanmasını engellemek için hedefi no-cache ile etiketleyin. Örneğin:

java_library(
    name = "target",
    tags = ["no-cache"],
)

Uzak önbellekten içerik silme

Uzak önbellekten içerik silmek, sunucunuzu yönetme işleminin bir parçasıdır. Uzak önbellekteki içeriği nasıl sileceğiniz, önbellek olarak ayarladığınız sunucuya bağlıdır. Çıkışları silerken önbelleğin tamamını veya eski çıkışları silin.

Önbelleğe alınan çıkışlar bir ad ve karma grubu olarak depolanır. İçerik silinirken hangi çıktının belirli bir derlemeye ait olduğunu ayırt etmek mümkün değildir.

Önbellekten içerik silmek için:

  • Önbelleğin bozulmasından sonra temiz bir önbellek oluşturma
  • Eski çıkışları silerek kullanılan depolama alanını azaltın

Unix soket

Uzak HTTP önbelleği, unix alan soketleri üzerinden bağlantı kurmayı destekler. Davranış, curl'ün --unix-socket işaretine benzer. Unix alan soketini yapılandırmak için aşağıdakileri kullanın:

   build --remote_cache=http://your.host:port
   build --remote_cache_proxy=unix:/path/to/socket

Bu özellik Windows'da desteklenmez.

Disk önbelleği

Bazel, dosya sistemindeki bir dizini uzak önbellek olarak kullanabilir. Bu, dallar arasında geçiş yaparken ve/veya birden fazla ödeme gibi aynı projenin birden fazla çalışma alanında çalışırken derleme yapılarını paylaşmak için faydalıdır. Bazel, dizini çöp toplamadığından bu dizinin düzenli olarak temizlenmesini otomatikleştirmek isteyebilirsiniz. Disk önbelleğini aşağıdaki şekilde etkinleştirin:

build --disk_cache=path/to/build/cache

~ takma adını kullanarak --disk_cache işaretine kullanıcıya özel bir yol iletebilirsiniz (Bazel, mevcut kullanıcının ana dizini ile değiştirir). Bu özellik, projenin kontrol edilen .bazelrc dosyası aracılığıyla projenin tüm geliştiricileri için disk önbelleğini etkinleştirirken kullanışlıdır.

Bilinen sorunlar

Derleme sırasında giriş dosyası değiştirme

Bir giriş dosyası derleme sırasında değiştirildiğinde Bazel, uzak önbelleğe geçersiz sonuçlar yükleyebilir. --experimental_guard_against_concurrent_changes işaretiyle değişiklik algılamayı etkinleştirebilirsiniz. Bilinen bir sorun yoktur ve gelecekteki bir sürümde varsayılan olarak etkinleştirilecektir. Güncellemeler için [issue #3360] başlıklı makaleyi inceleyin. Genel olarak, derleme sırasında kaynak dosyaları değiştirmekten kaçının.

İşleme sızdıran ortam değişkenleri

İşlem tanımı ortam değişkenlerini içerir. Bu, uzak önbellek isabetlerinin makineler arasında paylaşılmasında bir sorun olabilir. Örneğin, farklı $PATH değişkenlerine sahip ortamlar önbelleğe alınan isabetleri paylaşmaz. Yalnızca --action_env aracılığıyla açıkça beyaz listeye eklenen ortam değişkenleri bir işlem tanımına dahil edilir. Bazel'in Debian/Ubuntu paketi, $PATH dahil olmak üzere ortam değişkenlerinin beyaz listesiyle /etc/bazel.bazelrc yüklemek için kullanılır. Beklediğinizden daha az önbellek isabeti alıyorsanız ortamınızda eski bir /etc/bazel.bazelrc dosyası olup olmadığını kontrol edin.

Bazel, çalışma alanının dışındaki araçları izlemez

Bazel şu anda çalışma alanının dışındaki araçları izlememektedir. Bu durum, örneğin bir işlemde /usr/bin/ hizmetindeki bir derleyici kullanılıyorsa sorun olabilir. Ardından, farklı derleyiciler yüklü olan iki kullanıcı, çıktılar farklı olsa da aynı işlem karmasına sahip oldukları için önbelleğe alınan isabetleri yanlış bir şekilde paylaşır. Güncellemeler için 4558 numaralı soruna bakın.

Derlemeler Docker kapsayıcılarında çalıştırıldığında artımlı bellek içi durum kaybedilir Bazel, tek bir Docker kapsayıcısında çalıştırıldığında bile sunucu/istemci mimarisini kullanır. Sunucu tarafında Bazel, derlemeleri hızlandıran bir bellek içi durumu korur. CI gibi Docker kapsayıcılarının içinde derlemeler çalıştırırken bellek içi durum kaybedilir ve Bazel'in uzak önbelleği kullanmadan önce bunu yeniden oluşturması gerekir.