Update our project definition

Clarify that we are the OpenStack Containers service as officially
defined in OpenStack governance [1].

[1] https://git.openstack.org/cgit/openstack/governance/plain/
    reference/projects.yaml

Change-Id: I86b1b1ff7815214bd39d3ba0ec4a9fce9216d44d
This commit is contained in:
Hongbin Lu 2018-02-04 02:45:08 +00:00
parent 138281905e
commit d16f128d43
9 changed files with 30 additions and 30 deletions

View File

@ -13,11 +13,11 @@ Team and repository tags
Zun
===
Container Management service for OpenStack
OpenStack Containers service
Zun (ex. Higgins) is a Container Management service for OpenStack. It aims
to provide an OpenStack API for launching and managing containers backed by
different container technologies.
Zun (ex. Higgins) is the OpenStack Containers service. It aims to provide an
API service for running application containers without the need to manage
servers or clusters.
* Free software: Apache license
* Get Started: https://docs.openstack.org/zun/latest/contributor/quickstart.html

View File

@ -61,7 +61,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Container Management Service API Reference'
project = u'Containers Service API Reference'
copyright = u'2010-present, OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for
@ -202,7 +202,7 @@ htmlhelp_basename = 'zundoc'
# [howto/manual]).
latex_documents = [
('index', 'Zun.tex',
u'OpenStack Container Management Service API Documentation',
u'OpenStack Containers Service API Documentation',
u'OpenStack Foundation', 'manual'),
]

View File

@ -1,8 +1,8 @@
:tocdepth: 2
=================================
Container Management Service API
=================================
=======================
Containers Service API
=======================
.. rest_expand_all::

View File

@ -4,14 +4,14 @@
Manage Zun service
==================
Show container management service status
========================================
Show service status
===================
.. rest_method:: GET /v1/services
Enables administrative users to view details for all Zun services.
Container management service status details include service id, binary,
Service status details include service id, binary,
host, report count, creation time, last updated time, health status, and
the reason for disabling service.
@ -49,8 +49,8 @@ Response Example
:language: javascript
Delete container management service
===================================
Delete service
==============
.. rest_method:: DELETE /v1/services
@ -81,8 +81,8 @@ Response Parameters
If successful, this method does not return content in the response body.
Enable container management service
===================================
Enable service
==============
.. rest_method:: PUT /v1/services/enable
@ -125,8 +125,8 @@ Response Example
:language: javascript
Disable container management service
====================================
Disable service
===============
.. rest_method:: PUT /v1/services/disable
@ -170,8 +170,8 @@ Response Example
:language: javascript
Force down container management service
=======================================
Force down service
==================
.. rest_method:: PUT /v1/services/force_down

View File

@ -19,10 +19,10 @@ For instance, if the ``url`` is
``http://my-zun-url.org/zun/v1`` then the full API call for
``/containers`` is ``http://my-zun-url.org/zun/v1/containers``.
Depending on the deployment the container management service
Depending on the deployment the containers service
url might be http or https, a custom port, a custom path, and include your
project id. The only way to know the urls for your deployment is by using the
service catalog. The container management service URL should never be
service catalog. The containers service URL should never be
hard coded in applications, even if they are only expected to work at a
single site. It should always be discovered from the Identity token.

View File

@ -1,6 +1,6 @@
[metadata]
name = zun
summary = Container Management service for OpenStack
summary = OpenStack Containers service
description-file =
README.rst
author = OpenStack

View File

@ -57,7 +57,7 @@ class Root(base.APIBase):
root = Root()
root.name = "OpenStack Zun API"
root.description = ("Zun is an OpenStack project which aims to "
"provide container management.")
"provide containers service.")
root.versions = [Version.convert('v1', "CURRENT",
versions.CURRENT_MAX_VER,

View File

@ -20,7 +20,7 @@ rules = [
policy.DocumentedRuleDefault(
name=ZUN_SERVICE % 'delete',
check_str=base.RULE_ADMIN_API,
description='Delete a container management service.',
description='Delete a service.',
operations=[
{
'path': '/v1/services',
@ -31,7 +31,7 @@ rules = [
policy.DocumentedRuleDefault(
name=ZUN_SERVICE % 'disable',
check_str=base.RULE_ADMIN_API,
description='Disable a container management service.',
description='Disable a service.',
operations=[
{
'path': '/v1/services/disable',
@ -42,7 +42,7 @@ rules = [
policy.DocumentedRuleDefault(
name=ZUN_SERVICE % 'enable',
check_str=base.RULE_ADMIN_API,
description='Enable a container management service.',
description='Enable a service.',
operations=[
{
'path': '/v1/services/enable',
@ -53,7 +53,7 @@ rules = [
policy.DocumentedRuleDefault(
name=ZUN_SERVICE % 'force_down',
check_str=base.RULE_ADMIN_API,
description='Forcibly shutdown a container management service.',
description='Forcibly shutdown a service.',
operations=[
{
'path': '/v1/services/force_down',
@ -64,7 +64,7 @@ rules = [
policy.DocumentedRuleDefault(
name=ZUN_SERVICE % 'get_all',
check_str=base.RULE_ADMIN_API,
description='Show the status of a container management service.',
description='Show the status of a service.',
operations=[
{
'path': '/v1/services',

View File

@ -32,7 +32,7 @@ class TestRootController(api_base.FunctionalTest):
'min_version': '1.1',
'status': 'CURRENT'},
'description': 'Zun is an OpenStack project which '
'aims to provide container management.',
'aims to provide containers service.',
'name': 'OpenStack Zun API',
'versions': [{'id': 'v1',
'links': [{'href': 'http://localhost/v1/',