创建安全指南文档

https://blueprints.launchpad.net/sahara/+spec/security-guidelines-doc

随着 Sahara 功能和复杂性的增加,清晰简洁的文档需求也随之增长。 这对于安全相关主题尤其重要,因为目前这方面的内容严重不足。 本规范建议创建一个文档,作为 Sahara 相关安全主题、指南和说明的来源。

问题描述

目前 Sahara 缺乏集中式的安全相关文档。 已经实施了一些功能来解决安全漏洞,这些功能需要更广泛地讨论其应用和正确用法。 此外,目前没有文档讨论在 Sahara 中使用的各个插件技术的具体安全配置流程。

提议的变更

本规范建议创建 Sahara 专属文档,解决用户和操作员的安全问题。 该文档将涵盖当前功能、最佳实践以及安装和操作 Sahara 的指南。

通过此项工作生成的文档将包含在 OpenStack 安全指南[1]中。 将针对当前的 OpenStack 手册生成错误补丁,并将与 OpenStack 安全小组合作以最终确定并包含该文档。

该过程将分解为子章节,构成 OpenStack 安全指南的 Sahara 章节。 最初,这些子章节将包括:Sahara 控制器安装、当前功能讨论以及插件特定主题。

提供的信息旨在随着新的方法、插件和功能的实施而更新。 它也将通过标准 OpenStack 工作流程由社区进行补丁更新。

替代方案

创建由 Sahara 团队管理的独立文档,不属于 OpenStack 手册的范围,并通过 Sahara 文档进行分发。 这种解决方案并非理想,因为它为 OpenStack 手册创建了一条替代路径,而这与最终用户期望的位置不符。

创建如上所述的独立文档,但它将与其他的 OpenStack 手册一起维护。 与前一个选项相比,这个选项可能更合理,但它仍然存在创建与官方手册分离的安全相关指南替代位置的问题。 它还承担了在手册基础设施中创建一个新项目的负担。

数据模型影响

REST API 影响

其他最终用户影响

部署者影响

开发者影响

Sahara-image-elements impact

Sahara-dashboard / Horizon 影响

实现

负责人

主要负责人

mimccune (Michael McCune)

其他贡献者

工作项

  • 在 OpenStack 手册中创建一个 Sahara 章节的错误报告

  • 创建以下子章节的文档和更改请求

    • Sahara 控制器安装指南,重点关注安全性

    • 功能讨论和示例

    • 插件特定主题

      • Hadoop

      • Spark

      • Storm

依赖项

测试

按照安全指南项目提供的格式进行测试。

文档影响

本规范建议创建超文本和 PDF 文档。

参考资料

[1]: https://docs.openstack.org/security-guide/content/ch_preface.html