使用自定义 JSON 覆盖属性

聚焦模式

使用自定义 JSON 覆盖属性 - AWS OpsWorks

如何指定自定义 JSON 何时指定自定义 JSON 自定义 JSON 的最佳实践

重要

该 AWS OpsWorks Stacks 服务于 2024 年 5 月 26 日终止，新客户和现有客户均已禁用。我们强烈建议客户尽快将其工作负载迁移到其他解决方案。如果您对迁移有疑问，请通过 re AWS : Post 或通过 Pre mium Su AWS pp ort 与 AWS 支持团队联系。

注意

由于 AWS OpsWorks Stacks 处理 Windows 堆栈的 Chef 运行方式与 Linux 堆栈不同，因此你不能将本节中讨论的技术用于 Windows 堆栈。

重写 AWS OpsWorks Stacks 属性的最简单方法是在自定义 JSON 中对其进行定义，该属性优先于堆栈配置和部署属性以及内置和自定义食谱default属性。有关更多信息，请参阅属性优先顺序。

重要

您应谨慎地覆盖堆栈配置和部署属性。例如，覆盖 opsworks 命名空间中的属性可能会影响内置配方。有关更多信息，请参阅堆栈配置和部署属性。

您还可使用自定义 JSON 来定义唯一属性 (通常用于将数据传递到您的自定义配方)。这些属性将简单地并入到节点对象中，并且配方可通过使用标准 Chef 节点语法来引用它们。

如何指定自定义 JSON

要使用自定义 JSON 来覆盖某个属性值，您必须先确定该属性的完全限定属性名称。然后，您创建一个包含要覆盖、设置为您的首选值的属性的 JSON 对象。为方便起见，堆栈配置和部署属性：Linux 和内置说明书属性文档一般使用堆栈配置、部署和内置说明书属性，包括其完全限定名称。

对象的父子关系必须对应于适当的完全限定的 Chef 节点。例如，假设您需要更改以下 Apache 属性：

keepalivetimeout 属性，其节点为 node[:apache][:keepalivetimeout] 并且具有默认值 3。
logrotate schedule 属性，其节点为 node[:apache][:logrotate][:schedule]，并且具有默认值 "daily"。

要覆盖这些属性并将值分别设置为 5 和 "weekly"，可使用以下自定义 JSON：



{
  "apache" : {
    "keepalivetimeout" : 5,
    "logrotate" : {
       "schedule" : "weekly"
    }
  }
}

何时指定自定义 JSON

您可为下列任务指定自定义 JSON 结构：

对于每项任务， AWS OpsWorks Stacks 都会将自定义 JSON 属性与堆栈配置和部署属性合并，然后将其发送到实例，然后合并到节点对象中。但是，请注意以下事项：

如果您在创建、克隆或更新堆栈时指定自定义 JSON，则这些属性将会合并到用于所有后续事件和堆栈命令的堆栈配置和部署属性中。
如果您为部署指定自定义 JSON，则这些属性将会合并到仅用于相应的事件的堆栈配置和部署属性中。

如果您想要为后续部署使用这些自定义属性，必须再次显式指定自定义 JSON。

请务必记住，这些属性仅在配方使用它们时才会影响实例。如果您覆盖某个属性值，但没有后续配方引用该属性，则更改不会产生影响。您必须确保在关联的配方运行之前发送自定义 JSON，或者确保重新运行适当的配方。

自定义 JSON 的最佳实践

你可以使用自定义 JSON 来覆盖任何 AWS OpsWorks Stacks 属性，但是手动输入信息有点麻烦，而且不受任何形式的源代码控制。自定义 JSON 最适合以下用途：

您只想覆盖少量属性，并且您无需使用自定义说明书。

通过自定义 JSON，您可避免仅为了覆盖一些属性而设置和维护说明书存储库所带来的开销。
敏感值，如密码或身份验证密钥。

说明书属性存储在一个存储库中，因此所有敏感信息都有泄露风险。可以改为定义使用虚拟值的属性，然后使用自定义 JSON 设置真实值。
预计会变化的值。

例如，建议的做法是通过不同的开发和暂存堆栈来支持您的生产堆栈。假设这些堆栈支持某个用于接受付款的应用程序。如果您使用自定义 JSON 来指定付款终端节点，则可以为您的暂存堆栈指定一个测试 URL。当您准备好将更新后的堆栈迁移到生产堆栈时，可使用相同的说明书并使用自定义 JSON 来将付款终端节点设置为生产 URL。
特定于某个特殊堆栈或部署命令的值。