openstack/deb-murano
Code Issues Proposed changes

[Murano Docs]/[docs] Replace all instances of "tenant" with "project"

Browse Source 
There are multiple places throughout Murano docs that still
use the term "tenant". In order to help transition to v3
keystone API, these instances should be replaced with the word
"project".

All of the docs have been updated accordingly. I reference "tenant"
in parenthesis in a few appropriate places as a way to help with
any confusion during the transition.

Change-Id: I41de7c272198c471ae60fa47f3554085308dae68
Closes-Bug: #1514756
This commit is contained in:
darla.ahlert 2016-02-11 20:24:55 -06:00 committed by Darla Ahlert
parent 3598511b72
commit 4dcf4268a9
14 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/articles/client.rst
View File

@ -37,9 +37,9 @@ Using CLI client
================
In order to use the CLI, you must provide your OpenStack username, password,
tenant name or id, and auth endpoint. Use the corresponding arguments
(``--os-username``, ``--os-password``, ``--os-tenant-name`` or
``--os-tenant-id``, ``--os-auth-url`` and ``--murano-url``) or
project name or id, and auth endpoint. Use the corresponding arguments
(``--os-username``, ``--os-password``, ``--os-project-name`` or
``--os-project-id``, ``--os-auth-url`` and ``--murano-url``) or
set corresponding environment variables::
export OS_USERNAME=user

5
doc/source/articles/debug_tips.rst
View File

@ -17,8 +17,9 @@
Murano TroubleShooting and Debug Tips
=====================================
During installation and setting environment of new projects you can run into different problems.
This section intends to reduce the time spent on the solution of these problems.
During installation and setting environment of new projects (tenants) you
can run into different problems. This section intends to reduce the time
spent on the solution of these problems.
Problems during configuration
=============================

4
doc/source/articles/policy_enf_dev.rst
View File

@ -39,7 +39,7 @@ Transformed to these rules:
- ``murano:objects+("83bff5ac", "tenant_id", "io.murano.Environment")``
- ``murano:objects+("83bff5ac", "e7a13d3c", "io.murano.databases.MySql")``
.. note:: The owner of the environment is a tenant
.. note:: The owner of the environment is a project
``murano:properties(object_id, property_name, property_value)``
@ -188,4 +188,4 @@ Transformed to these rules:
Currently only one record for environment is created:
- ``murano:states+("uugi324", "pending")``
- ``murano:states+("uugi324", "pending")``

10
doc/source/articles/policy_enf_setup.rst
View File

@ -50,19 +50,19 @@ following command.
- **murano** policy
Policy is created by Congress' murano datasource driver, which is part of
Congress. It has to be configured for the OpenStack tenant where Murano
application will be deployed. Datasource driver retrieves deployed Murano
environments and populates Congress' murano policy tables
Congress. It has to be configured for the OpenStack project (tenant) where
Murano application will be deployed. Datasource driver retrieves deployed
Murano environments and populates Congress' murano policy tables
(:ref:`policyenf_dev`).
Following commands removes existing **murano** policy, and creates new
**murano** policy configured for tenant *demo*.
**murano** policy configured for project *demo*.
.. code-block:: console
. ~/devstack/openrc admin admin # if you are using devstack, otherwise you have to setup env manually
# remove default murano datasource configuration, because it is using 'admin' tenant. We need 'demo' tenant to be used.
# remove default murano datasource configuration, because it is using 'admin' project. We need 'demo' project to be used.
openstack congress datasource delete murano
openstack congress datasource create murano murano --config username="$OS_USERNAME" --config tenant_name="demo" --config password="$OS_PASSWORD" --config auth_url="$OS_AUTH_URL"
..

2
doc/source/draft/admin-guide/configure_cloud_foundry_service_broker.rst
View File

@ -33,7 +33,7 @@ broker in a few simple steps:
.. code-block:: ini
[cfapi]
tenat = %TENANT_NAME%
tenant = %TENANT_NAME%
bind_host = %HOST_IP%
bind_port = 8083
auth_url = 'http://%OPENSTACK_HOST_IP%:5000/v2.0'

2
doc/source/draft/admin-guide/policy_enforcement/policy_enf_dev.rst
View File

@ -44,7 +44,7 @@ of rules that are as follows:
.. note::
The owner of the environment is a tenant.
The owner of the environment is a project (tenant).
**murano:properties(object_id, property_name, property_value)**

6
doc/source/draft/admin-guide/policy_enforcement/policy_enf_setup.rst
View File

@ -41,17 +41,17 @@ properly.
* ``murano`` policy
It is created by the Congress` murano datasource driver, which is a part
of Congress. Configure it for the OpenStack tenant where you plan to
of Congress. Configure it for the OpenStack project (tenant) where you plan to
deploy your Murano application. Datasource driver retrieves deployed
Murano environments and populates Congress' murano policy tables.
See :ref:`policyenf_dev` for details.
Remove the existing ``murano`` policy and create a new ``murano`` policy
configured for the ``demo`` tenant, by running:
configured for the ``demo`` project, by running:
.. code-block:: console
# remove default murano datasource configuration, because it is using 'admin' tenant. We need 'demo' tenant to be used.
# remove default murano datasource configuration, because it is using 'admin' project. We need 'demo' project to be used.
openstack congress datasource delete murano
openstack congress datasource create murano murano --config username="$OS_USERNAME" --config tenant_name="demo" --config password="$OS_PASSWORD" --config auth_url="$OS_AUTH_URL"

2
doc/source/draft/appdev-guide/app_migrating/app_migrate_to_liberty.rst
View File

@ -196,7 +196,7 @@ their VM: to a new network created during the deployment, or to an already
existing network.
Dynamic UI now has a new type of field - ``NetworkChoiseField``. This field
provides a selection of networks and their subnetworks as a dropdown populated
with those which are available to the current tenant.
with those which are available to the current project (tenant).
To use this feature, you should make the following updates in the Dynamic UI of
an application:

12
doc/source/draft/appendix/cli_ref.rst
View File

@ -131,11 +131,11 @@ Murano optional arguments
**--os-password OS_PASSWORD**
Defaults to env[OS_PASSWORD]
**--os-tenant-id OS_TENANT_ID**
Defaults to env[OS_TENANT_ID]
**--os-project-id OS_PROJECT_ID**
Defaults to env[OS_PROJECT_ID]
**--os-tenant-name OS_TENANT_NAME**
Defaults to env[OS_TENANT_NAME]
**--os-project-name OS_PROJECT_NAME**
Defaults to env[OS_PROJECT_NAME]
**--os-auth-url OS_AUTH_URL**
Defaults to env[OS_AUTH_URL]
@ -197,7 +197,7 @@ Optional arguments
~~~~~~~~~~~~~~~~~~
**--is-public**
Make packages available to users from other tenants
Make packages available to users from other project
**--exists-action {a,s,u}**
Default action when a package already exists
@ -565,7 +565,7 @@ Optional arguments
Category list to attach
**--is-public**
Make the package available for user from other tenants
Make the package available for user from other project
**--package-version VERSION**
Version of the package to use from repository (ignored when importing with

2
doc/source/draft/enduser-guide/use_cli.rst
View File

@ -121,7 +121,7 @@ For example:
| 83e4038885c248e3a758f8217ff8241f| MySQL| io.murano.databases.MySql| Mirantis, Inc| |
+---------------------------------+------+--------------------------+--------------+---------+
To make the package available for users from other tenants, use the
To make the package available for users from other projects (tenants), use the
``--is-public`` parameter. For example:
.. code-block:: console

2
doc/source/draft/intro/key_features.rst
View File

@ -89,7 +89,7 @@ Application lifecycle management
#. Isolation:
* Applications in the same environments can easily interact with
each other, though applications between different tenants are isolated.
each other, though applications between different projects (tenants) are isolated.

17
doc/source/specification/murano-api.rst
View File

@ -20,10 +20,9 @@ Glossary
* **Environment**
The environment is a set of applications managed by a single tenant. They could be related logically with each other or not.
The environment is a set of applications managed by a single project (tenant). They could be related logically with each other or not.
Applications within a single environment may comprise of complex configuration while applications in different environments are always
independent from one another. Each environment is associated with a single
OpenStack project (tenant).
independent from one another. Each environment is associated with a single OpenStack project.
.. _`sessions`:
@ -44,7 +43,7 @@ Glossary
A .zip archive, containing instructions for an application deployment.
* **Environment-Template**
The environment template is the specification of a set of applications managed by a single tenant, which are
The environment template is the specification of a set of applications managed by a single project, which are
related to each other. The environment template is stored in an environment template catalog, and it can be
managed by the user (creation, deletion, updating). Finally, it can be deployed on OpenStack by translating
into an environment.
@ -64,7 +63,7 @@ Environment API
+----------------------+------------+-------------------------------------------+
| updated | datetime | Modification date and time in ISO format |
+----------------------+------------+-------------------------------------------+
| tenant_id | string | OpenStack tenant ID |
| tenant_id | string | OpenStack project ID |
+----------------------+------------+-------------------------------------------+
| version | int | Current version |
+----------------------+------------+-------------------------------------------+
@ -103,9 +102,9 @@ List environments
*Parameters:*
* `all_tenants` - boolean, indicates whether environments from all tenants are listed.
*True* environments from all tenants are listed. Admin user required.
*False* environments only from current tenant are listed (default like option unspecified).
* `all_tenants` - boolean, indicates whether environments from all projects are listed.
*True* environments from all projects are listed. Admin user required.
*False* environments only from current project are listed (default like option unspecified).
*Response*
@ -842,7 +841,7 @@ General Request Statistics
+----------------------+------------+-----------------------------------------------------------------+
| Attribute | Type | Description |
+======================+============+=================================================================+
| requests_per_tenant | int | Number of incoming requests for user tenant |
| requests_per_tenant | int | Number of incoming requests for user project |
+----------------------+------------+-----------------------------------------------------------------+
| errors_per_second | int | Class name of the statistic object |
+----------------------+------------+-----------------------------------------------------------------+

10
doc/source/specification/murano-env-temp.rst
View File

@ -32,7 +32,7 @@ it into an environment. In addition, applications can be added to or deleted fro
+----------------------+------------+-------------------------------------------+
| updated | datetime | Modification date and time in ISO format |
+----------------------+------------+-------------------------------------------+
| tenant_id | string | OpenStack tenant ID |
| tenant_id | string | OpenStack project |
+----------------------+------------+-------------------------------------------+
| version | int | Current version |
+----------------------+------------+-------------------------------------------+
@ -68,9 +68,9 @@ List Environments Templates
*Parameters:*
* `is_public` - boolean, indicates whether public environment templates are listed or not.
*True* public environments templates from all tenants are listed.
*False* private environments templates from current tenant are listed
*empty* all tenant templates plus public templates from all tenants are listed
*True* public environments templates from all projects are listed.
*False* private environments templates from current project are listed
*empty* all project templates plus public templates from all projects are listed
*Response*
@ -432,7 +432,7 @@ Create an environment from an environment template
+----------+--------------------------------+-------------------------------------------------+
| Method | URI | Description |
+==========+================================+=================================================+
| POST | /templates/{env-temp-id}/clone | It clones a public template from one tenant |
| POST | /templates/{env-temp-id}/clone | It clones a public template from one project |
| | | to another |
+----------+--------------------------------+-------------------------------------------------+

18
doc/source/specification/murano-repository.rst
View File

@ -35,9 +35,9 @@ Methods for application package management
- ``tags``: list of short names, connected with the package, which allows to search applications easily
- ``categories``: list of application categories
- ``class_definition``: list of class names used by a package
- ``is_public``: determines whether the package is shared for other tenants
- ``is_public``: determines whether the package is shared for other projects
- ``enabled``: determines whether the package is browsed in the Application Catalog
- ``owner_id``: id of a tenant that owns the package
- ``owner_id``: id of a project that owns the package
List packages
-------------
@ -45,7 +45,7 @@ List packages
`/v1/catalog/packages?{marker}{limit}{order_by}{type}{category}{fqn}{owned}{id}{catalog}{class_name}{name} [GET]`
This is the compound request to list and search through application catalog.
If there are no search parameters all packages that is_public, enabled and belong to the user's tenant will be listed.
If there are no search parameters all packages that is_public, enabled and belong to the user's project will be listed.
Default order is by 'created' field.
For an admin role all packages are available.
@ -71,7 +71,7 @@ For an admin role all packages are available.
+----------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+
| ``fqn`` | string | Allows to point a fully qualified package name for a search |
+----------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+
| ``owned`` | bool | Search only from packages owned by current tenant |
| ``owned`` | bool | Search only from packages owned by current project |
+----------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+
| ``id`` | string | Allows to point an id for a search | |
+----------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+
@ -224,7 +224,7 @@ Display details for a package.
**Response 403**
* In attempt to get a non-public package by a user whose tenant is not an owner of this package.
* In attempt to get a non-public package by a user whose project is not an owner of this package.
**Response 404**
@ -302,7 +302,7 @@ Allowed operations:
* An attempt to update immutable fields
* An attempt to perform operation that is not allowed on the specified path
* An attempt to update non-public package by user whose tenant is not an owner of this package
* An attempt to update non-public package by user whose project is not an owner of this package
**Response 404**
@ -364,7 +364,7 @@ Specified package id doesn't exist
**Response 403**
Specified package is not public and not owned by user tenant, performing the request
Specified package is not public and not owned by user project, performing the request
**Response 404**
@ -388,12 +388,12 @@ The sequence of bytes representing application logo
**Response 403**
Specified package is not public and not owned by user tenant,
Specified package is not public and not owned by user project,
performing the request
**Response 404**
Specified package is not public and not owned by user tenant,
Specified package is not public and not owned by user project,
performing the request
Categories