From e1870b4cc2371b468e5a90e09e97b784a2e24844 Mon Sep 17 00:00:00 2001 From: Jimmy McArthur Date: Fri, 19 Oct 2018 09:55:34 -0500 Subject: [PATCH] Adds docs and download links for all projects Adds docs and download tags for all projects Updated docs links for every project, as applicable Change-Id: I41baef8e7dfc38faf6c2f5ac55f98273c3788f3a Signed-off-by: Jimmy McArthur --- deployment_tools.yaml | 41 +++++++++++++++++++ openstack_components.yaml | 86 +++++++++++++++++++++++++++++++++++++++ sdks.yaml | 21 ++++++---- 3 files changed, 139 insertions(+), 9 deletions(-) diff --git a/deployment_tools.yaml b/deployment_tools.yaml index 8fac168..7cb643d 100644 --- a/deployment_tools.yaml +++ b/deployment_tools.yaml @@ -15,6 +15,8 @@ tabs: - name: tripleo title: Deploys OpenStack using OpenStack itself + docs-title: Docs + docs-url: https://docs.openstack.org/tripleo-docs/latest/ desc: > TripleO is a project aimed at installing, upgrading and operating OpenStack clouds using OpenStack’s own cloud @@ -25,6 +27,8 @@ tabs: - name: openstack-helm title: Deploys OpenStack in containers using Helm + docs-title: Docs + docs-url: https://docs.openstack.org/openstack-helm/latest/ desc: > Collection of Helm charts that simply, resiliently, and flexibly deploy OpenStack and related services on Kubernetes. @@ -32,6 +36,8 @@ tabs: - name: kolla-ansible title: Deploys OpenStack in containers using Ansible + docs-title: Docs + docs-url: https://docs.openstack.org/kolla-ansible/latest/ desc: > Kolla-Ansible deploys OpenStack via Kolla containers using the Ansible framework. @@ -43,13 +49,24 @@ tabs: - name: openstack-charms title: Deploys OpenStack in containers using Charms and Juju + docs-title: Docs + docs-url: https://docs.openstack.org/openstack-chef/latest/ + download-title: Find OpenStack Charms in the Charm Store + download-url: https://jujucharms.com/openstack desc: > Collection of Charms to deploy OpenStack using the Juju framework. project-team: OpenStack Charms + links: + - Juju Solutions for OpenStack: https://jujucharms.com/openstack + - Install OpenStack: https://www.ubuntu.com/openstack/install + - Install single-server OpenStack with conjure-up: > + https://tutorials.ubuntu.com/tutorial/install-openstack-with-conjure-up - name: bifrost title: Ansible playbooks using ironic + docs-title: Docs + docs-url: https://docs.openstack.org/bifrost/latest/ desc: > Bifrost (pronounced bye-frost) is a set of Ansible playbooks that automates the task of deploying a base image onto a set of @@ -63,6 +80,8 @@ tabs: - name: LOCI title: Lightweight OCI containers + docs-title: Project Wiki + docs-url: https://wiki.openstack.org/wiki/LOCI desc: > Recipes and tools to build lightweight OCI compliant container tooling and images for OpenStack services. @@ -70,12 +89,34 @@ tabs: - name: puppet-openstack title: Puppet modules to deploy OpenStack + docs-title: Docs + docs-url: https://docs.openstack.org/puppet-openstack-guide/latest/ + desc: > + Puppet OpenStack modules bring scalable and reliable IT + automation to OpenStack cloud deployments. project-team: Puppet OpenStack - name: chef-openstack title: Chef cookbooks to deploy OpenStack + docs-title: Docs + docs-url: https://docs.openstack.org/openstack-chef/latest/ + download-title: Download + download-url: https://supermarket.chef.io/users/openstack + desc: > + The Chef cookbooks for OpenStack automate the building, operation + and consumption of OpenStack cloud deployments. project-team: Chef OpenStack - name: RPM-packaging title: RPM package specs to deploy OpenStack + docs-title: Project Wiki + docs-url: https://wiki.openstack.org/wiki/Rpm-packaging + desc: > + RPM Packaging for OpenStack is an cross-distribution and + cross-vendor effort to create common templates for building + OpenStack packages for RPM based Linux and OpenStack + distributions. The project was started with the goal of + unifying the independent packaging efforts of RDO and SUSE, + but is really open for anyone who wants to contribute RPM + packaging spec files for any distribution. project-team: Packaging-rpm diff --git a/openstack_components.yaml b/openstack_components.yaml index 29a194c..96ce2a3 100644 --- a/openstack_components.yaml +++ b/openstack_components.yaml @@ -16,6 +16,8 @@ tabs: - name: nova title: Compute Service + docs-title: Docs + docs-url: https://docs.openstack.org/nova/latest/ desc: > To implement services and associated libraries to provide massively scalable, on demand, self service access to compute @@ -32,6 +34,8 @@ tabs: - name: zun title: Containers Service + docs-title: Docs + docs-url: https://docs.openstack.org/zun/latest/ desc: > Zun provides an OpenStack API for launching and managing containers backed by different container technologies. @@ -47,6 +51,8 @@ tabs: - name: qinling title: Functions Service + docs-title: Docs + docs-url: https://docs.openstack.org/qinling/latest/ desc: > Qinling provides a platform to support serverless functions (like AWS Lambda). @@ -58,6 +64,8 @@ tabs: - name: ironic title: Bare Metal Provisioning Service + docs-title: Docs + docs-url: https://docs.openstack.org/ironic/latest/ desc: > To implement services and associated libraries to provide massively scalable, on demand, self service access to compute @@ -72,6 +80,8 @@ tabs: - name: cyborg title: Accelerators resource management + docs-title: Docs + docs-url: https://docs.openstack.org/cyborg/latest/ desc: > Cyborg provides a general purpose management framework for acceleration resources (i.e. various types of accelerators such @@ -87,6 +97,8 @@ tabs: - name: swift title: Object store + docs-title: Docs + docs-url: https://docs.openstack.org/swift/latest/ desc: > Swift is a highly available, distributed, eventually consistent object/blob store. Organizations can use Swift to store lots of @@ -101,6 +113,8 @@ tabs: - name: cinder title: Block Storage + docs-title: Docs + docs-url: https://docs.openstack.org/cinder/latest/ desc: > Cinder is a Block Storage service for OpenStack. It virtualizes the management of block storage devices and provides end users @@ -116,6 +130,8 @@ tabs: - name: manila title: Shared filesystems + docs-title: Docs + docs-url: https://docs.openstack.org/manila/latest/ desc: > Manila provides coordinated access to shared or distributed file systems. @@ -127,6 +143,8 @@ tabs: - name: neutron title: Networking + docs-title: Docs + docs-url: https://docs.openstack.org/neutron/latest/ desc: > OpenStack Neutron is an SDN networking project focused on delivering networking-as-a-service (NaaS) in virtual compute @@ -138,6 +156,8 @@ tabs: - name: octavia title: Load balancer + docs-title: Docs + docs-url: https://docs.openstack.org/octavia/latest/ desc: > Octavia is an open source, operator-scale load balancing solution designed to work with OpenStack. Octavia was borne out of the @@ -154,6 +174,8 @@ tabs: - name: designate title: DNS service + docs-title: Docs + docs-url: https://docs.openstack.org/designate/latest/ desc: > Designate provides DNS-as-a-service for OpenStack. project-team: designate @@ -164,6 +186,8 @@ tabs: - name: keystone title: Identity service + docs-title: Docs + docs-url: https://docs.openstack.org/keystone/latest/ desc: > Keystone is an OpenStack service that provides API client authentication, service discovery, and distributed multi-tenant @@ -174,6 +198,8 @@ tabs: - name: glance title: Image service + docs-title: Docs + docs-url: https://docs.openstack.org/glance/latest/ desc: > Glance image services include discovering, registering, and retrieving virtual machine images. Glance has a RESTful API @@ -189,6 +215,8 @@ tabs: - name: barbican title: Key management + docs-title: Docs + docs-url: https://docs.openstack.org/barbican/latest/ desc: > Barbican is the OpenStack Key Manager service. It provides secure storage, provisioning and management of secret data, such as @@ -199,6 +227,8 @@ tabs: - name: karbor title: Application Data Protection as a Service + docs-title: Docs + docs-url: https://docs.openstack.org/karbor/latest/ desc: > Karbor deals with protecting the Data and Meta-Data that comprises an OpenStack-deployed application against loss/damage @@ -212,6 +242,8 @@ tabs: - name: searchlight title: Indexing and Search + docs-title: Docs + docs-url: https://docs.openstack.org/searchlight/latest/ desc: > The Searchlight project provides indexing and search capabilities across OpenStack resources. Its goal is to achieve high @@ -228,6 +260,8 @@ tabs: - name: heat title: Orchestration + docs-title: Docs + docs-url: https://docs.openstack.org/heat/latest/ desc: > Heat orchestrates the infrastructure resources for a cloud application based on templates in the form of text files that @@ -241,6 +275,8 @@ tabs: - name: senlin title: Clustering service + docs-title: Docs + docs-url: https://docs.openstack.org/senlin/latest/ desc: > Senlin is a clustering service for OpenStack clouds. It creates and operates clusters of homogeneous objects exposed by other @@ -251,6 +287,8 @@ tabs: - name: mistral title: Workflow service + docs-title: Docs + docs-url: https://docs.openstack.org/mistral/latest/ desc: > Mistral is a workflow service. Most business processes consist of multiple distinct interconnected steps that need to be @@ -265,6 +303,8 @@ tabs: - name: zaqar title: Messaging Service + docs-title: Docs + docs-url: https://docs.openstack.org/zaqar/latest/ desc: > Zaqar is a multi-tenant cloud messaging service for web and mobile developers. The service features a fully RESTful API, @@ -281,6 +321,8 @@ tabs: - name: blazar title: Resource reservation service + docs-title: Docs + docs-url: https://docs.openstack.org/blazar/latest/ desc: > Blazar is a resource reservation service for OpenStack. Blazar enables users to reserve a specific type/amount of resources for @@ -303,6 +345,8 @@ tabs: - name: magnum title: Container Orchestration Engine Provisioning + docs-title: Docs + docs-url: https://docs.openstack.org/magnum/latest/ desc: > Magnum makes container orchestration engines such as Docker Swarm, Kubernetes, and Apache Mesos available as first class @@ -317,6 +361,8 @@ tabs: - name: sahara title: Big Data Processing Framework Provisioning + docs-title: Docs + docs-url: https://docs.openstack.org/sahara/latest/ desc: > The sahara project aims to provide users with a simple means to provision data processing frameworks (such as Hadoop, Spark @@ -328,6 +374,8 @@ tabs: - name: trove title: Database as a Service + docs-title: Docs + docs-url: https://docs.openstack.org/trove/latest/ desc: > Trove is a database-as-a-service provisioning relational and non-relational database engines. @@ -339,6 +387,8 @@ tabs: - name: masakari title: Instances High Availability Service + docs-title: Docs + docs-url: https://docs.openstack.org/masakari/latest/ desc: > Masakari provides Instances High Availability Service for OpenStack clouds by automatically recovering failed Instances. @@ -351,6 +401,8 @@ tabs: - name: murano title: Application Catalog + docs-title: Docs + docs-url: https://docs.openstack.org/murano/latest/ desc: > Murano enables application developers and cloud administrators to publish various cloud-ready applications in a browsable @@ -365,6 +417,8 @@ tabs: - name: solum title: Software Development Lifecycle Automation + docs-title: Docs + docs-url: https://docs.openstack.org/solum/latest/ desc: > To make cloud services easier to consume and integrate with your application development process by automating the @@ -374,6 +428,8 @@ tabs: - name: freezer title: Backup, Restore, and Disaster Recovery + docs-title: Docs + docs-url: https://docs.openstack.org/freezer/latest/ desc: > Freezer is a distributed backup, restore and disaster recovery as a service platform. It is designed to be multi OS (Linux, @@ -391,6 +447,8 @@ tabs: - name: EC2API title: EC2 API proxy + docs-title: Docs + docs-url: https://docs.openstack.org/ec2-api/latest/ desc: > Provides an EC2-compatible API to OpenStack Nova. project-team: ec2api @@ -403,6 +461,8 @@ tabs: - name: horizon title: Dashboard + docs-title: Docs + docs-url: https://docs.openstack.org/horizon/latest/ desc: > Horizon is the canonical implementation of OpenStack's dashboard, which is extensible and provides a web based user interface to @@ -422,6 +482,8 @@ tabs: - name: ceilometer title: Metering & Data Collection Service + docs-title: Docs + docs-url: https://docs.openstack.org/ceilometer/latest/ desc: > Ceilometer's goal is to efficiently collect, normalise and transform data produced by OpenStack services. The data it @@ -435,6 +497,8 @@ tabs: - name: panko title: Event, Metadata Indexing Service + docs-title: Docs + docs-url: https://docs.openstack.org/panko/latest/ desc: > Panko is designed to provide a metadata indexing, event storage service which enables users to capture the state information of @@ -446,6 +510,8 @@ tabs: - name: monasca title: Monitoring + docs-title: Docs + docs-url: https://docs.openstack.org/monasca/latest/ desc: > Monasca is a open-source multi-tenant, highly scalable, performant, fault-tolerant monitoring-as-a-service solution @@ -460,6 +526,8 @@ tabs: - name: watcher title: Optimization Service + docs-title: Docs + docs-url: https://docs.openstack.org/watcher/latest/ desc: > Watcher provides a flexible and scalable resource optimization service for multi-tenant OpenStack-based clouds. Watcher provides @@ -470,6 +538,8 @@ tabs: - name: vitrage title: Root Cause Analysis service + docs-title: Docs + docs-url: https://docs.openstack.org/vitrage/latest/ desc: > Vitrage is the OpenStack service for Root Cause Analysis. It is used to organize, analyze and visualize OpenStack alarms & @@ -480,6 +550,8 @@ tabs: - name: congress title: Governance + docs-title: Docs + docs-url: https://docs.openstack.org/congress/latest/ desc: > Congress is an OpenStack project to provide policy as a service across any collection of cloud services in order to offer @@ -489,6 +561,8 @@ tabs: - name: rally title: Benchmark service + docs-title: Docs + docs-url: https://docs.openstack.org/rally/latest/ desc: > Rally is a benchmarking and performance analysis tool for OpenStack that can be used to automate measuring and profiling @@ -505,6 +579,8 @@ tabs: - name: cloudkitty title: Billing and chargebacks + docs-title: Docs + docs-url: https://docs.openstack.org/cloudkitty/latest/ desc: > CloudKitty is a rating-as-a-service project designed to translate metrics to prices. CloudKitty supports multiple collectors, @@ -517,6 +593,8 @@ tabs: - name: tricircle title: Networking Automation for Multi-Region Deployments + docs-title: Docs + docs-url: https://docs.openstack.org/tricircle/latest/ desc: > Tricircle provides networking automation across Neutron in multi-region OpenStack deployments. Use cases include application @@ -537,6 +615,8 @@ tabs: - name: storlets title: Computable object storage + docs-title: Docs + docs-url: https://docs.openstack.org/storlets/latest/ desc: > Openstack Storlets is an extension to Openstack Swift with the ability to run user defined computations - called storlets - @@ -555,6 +635,8 @@ tabs: - name: dragonflow title: Distributed SDN controller + docs-title: Docs + docs-url: https://docs.openstack.org/dragonflow/latest/ desc: > Dragonflow is a distributed SDN controller for OpenStack Neutron supporting distributed Switching, Routing, DHCP and more. @@ -573,6 +655,8 @@ tabs: - name: kuryr title: OpenStack Networking integration for containers + docs-title: Docs + docs-url: https://docs.openstack.org/kuryr/latest/ desc: > Bridge between containers frameworks networking models to OpenStack networking abstraction @@ -585,6 +669,8 @@ tabs: - name: tacker title: NFV Orchestration + docs-title: Docs + docs-url: https://docs.openstack.org/tacker/latest/ desc: > Tacker provides a generic VNF Manager (VNFM) and an NFV Orchestrator (NFVO) to deploy and operate Network Services diff --git a/sdks.yaml b/sdks.yaml index 3f30c2f..a5df870 100644 --- a/sdks.yaml +++ b/sdks.yaml @@ -14,36 +14,39 @@ tabs: - name: openstackclient title: Command-line interface for all OpenStack services + docs-title: Docs + docs-url: https://docs.openstack.org/python-openstackclient/latest/ + download-title: Download + download-url: https://pypi.org/project/python-openstackclient/ desc: > Single command-line interface for OpenStack services with a uniform command set and format. project-team: OpenStackClient - links: - - Download: https://pypi.org/project/python-openstackclient/ - - Docs: https://docs.openstack.org/python-openstackclient/latest/ - name: shade title: Client library for interacting with OpenStack clouds + docs-title: Docs + docs-url: https://docs.openstack.org/shade/latest/ + download-title: Download + download-url: https://pypi.org/project/shade/ desc: > shade is a simple client library for interacting with OpenStack clouds. The key word here is simple. Clouds can do many many many things - but there are probably only about 10 of them that most people care about with any regularity. project-team: Shade - links: - - Download: https://pypi.org/project/shade/ - - Docs: https://docs.openstack.org/shade/latest/ - category: Python SDKs components: - name: openstacksdk title: Official Python SDK for OpenStack APIs + docs-title: Docs + docs-url: https://docs.openstack.org/openstacksdk/latest/ + download-title: Download + download-url: https://pypi.org/project/openstacksdk/ desc: > Multi-cloud aware Python SDK for the OpenStack REST API exposing both the full set of low-level APIs as well as curated higher level business logic. project-team: OpenStackSDK - links: - - Download: https://pypi.org/project/openstacksdk/ - - Docs: https://docs.openstack.org/openstacksdk/latest/