English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย

Gateway

Secrets apply plan sözleşmesi

Bu sayfa, openclaw secrets apply tarafından zorunlu tutulan katı sözleşmeyi tanımlar.

Bir hedef bu kurallarla eşleşmezse, apply yapılandırmayı değiştirmeden önce başarısız olur.

Plan dosyası şekli

openclaw secrets apply --from <plan.json>, plan hedeflerinden oluşan bir targets dizisi bekler:

{
  version: 1,
  protocolVersion: 1,
  targets: [
    {
      type: "models.providers.apiKey",
      path: "models.providers.openai.apiKey",
      pathSegments: ["models", "providers", "openai", "apiKey"],
      providerId: "openai",
      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
    },
    {
      type: "auth-profiles.api_key.key",
      path: "profiles.openai:default.key",
      pathSegments: ["profiles", "openai:default", "key"],
      agentId: "main",
      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
    },
  ],
}

Desteklenen hedef kapsamı

Plan hedefleri, şu konumlardaki desteklenen kimlik bilgisi yolları için kabul edilir:

Hedef türü davranışı

Genel kural:

  • target.type tanınmalıdır ve normalize edilmiş target.path şekliyle eşleşmelidir.

Uyumluluk takma adları mevcut planlar için kabul edilmeye devam eder:

  • models.providers.apiKey
  • skills.entries.apiKey
  • channels.googlechat.serviceAccount

Yol doğrulama kuralları

Her hedef aşağıdakilerin tümüyle doğrulanır:

  • type tanınan bir hedef türü olmalıdır.
  • path boş olmayan bir noktalı yol olmalıdır.
  • pathSegments atlanabilir. Verilirse, path ile tam olarak aynı yola normalize edilmelidir.
  • Yasaklı segmentler reddedilir: __proto__, prototype, constructor.
  • Normalize edilmiş yol, hedef türü için kaydedilmiş yol şekliyle eşleşmelidir.
  • providerId veya accountId ayarlıysa, yolda kodlanmış kimlikle eşleşmelidir.
  • auth-profiles.json hedefleri agentId gerektirir.
  • Yeni bir auth-profiles.json eşlemesi oluştururken authProfileProvider ekleyin.

Başarısızlık davranışı

Bir hedef doğrulamayı geçemezse, apply şu şekilde bir hatayla çıkar:

Invalid plan target path for models.providers.apiKey: models.providers.openai.baseUrl

Geçersiz bir plan için hiçbir yazma işlemi işlenmez.

Exec sağlayıcı onay davranışı

  • --dry-run, varsayılan olarak exec SecretRef denetimlerini atlar.
  • Exec SecretRef/sağlayıcı içeren planlar, --allow-exec ayarlanmadıkça yazma modunda reddedilir.
  • Exec içeren planları doğrularken/uygularken hem dry-run hem de yazma komutlarında --allow-exec geçin.

Çalışma zamanı ve denetim kapsamı notları

  • Yalnızca ref içeren auth-profiles.json girdileri (keyRef/tokenRef), çalışma zamanı çözümlemesine ve denetim kapsamına dahildir.
  • secrets apply, desteklenen openclaw.json hedeflerini, desteklenen auth-profiles.json hedeflerini ve isteğe bağlı scrub hedeflerini yazar.

Operatör denetimleri

# Yazma işlemi olmadan planı doğrula
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run

# Sonra gerçekten uygula
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json

# Exec içeren planlar için, her iki modda da açıkça dahil olun
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run --allow-exec
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --allow-exec

Apply geçersiz hedef yolu iletisiyle başarısız olursa, planı openclaw secrets configure ile yeniden oluşturun veya hedef yolunu yukarıdaki desteklenen bir şekle düzeltin.

İlgili belgeler