Fix: various documentation and URL fixes
1) UCP -> Airship 2) readthedocs.org -> readthedocs.io (there is redirect) 3) http -> https 4) attcomdev -> airshipit (repo on quay.io) 5) att-comdev -> openstack/airship-* (repo on github/openstack git) 6) many URLs have been verified and adjusted to be current 7) no need for 'en/latest/' path in URL of the RTD 8) added more info to some setup.cfg and setup.py files 9) ucp-integration docs are now in airship-in-a-bottle 10) various other minor fixes Change-Id: I4b8cc6ddf491e35d600a83f5f82d7717108e31dd
This commit is contained in:
parent
38a12fc4fc
commit
7fa3136470
@ -11,7 +11,7 @@ insert_final_newline = true
|
|||||||
trim_trailing_whitespace = true
|
trim_trailing_whitespace = true
|
||||||
|
|
||||||
[*.py]
|
[*.py]
|
||||||
# Note: Undercloud components use PEP8 line length of 79
|
# Note: Airship components use PEP8 line length of 79
|
||||||
# Note: for VS Code, set "editor.rulers":[79] in your workspace settings
|
# Note: for VS Code, set "editor.rulers":[79] in your workspace settings
|
||||||
max_line_length = 79
|
max_line_length = 79
|
||||||
|
|
||||||
|
@ -51,5 +51,5 @@ If you find a bug, please feel free to create a `Storyboard issue`_.
|
|||||||
.. _Promenade: https://github.com/openstack/airship-promenade
|
.. _Promenade: https://github.com/openstack/airship-promenade
|
||||||
.. _Armada: https://github.com/openstack/airship-armada
|
.. _Armada: https://github.com/openstack/airship-armada
|
||||||
.. _OpenStack Helm: https://github.com/openstack/openstack-helm
|
.. _OpenStack Helm: https://github.com/openstack/openstack-helm
|
||||||
.. _documentation: http://airship-shipyard.readthedocs.io/en/latest/
|
.. _documentation: https://airship-shipyard.readthedocs.io/
|
||||||
.. _Storyboard issue: https://storyboard.openstack.org/#!/project/1010
|
.. _Storyboard issue: https://storyboard.openstack.org/#!/project/1010
|
||||||
|
@ -20,11 +20,11 @@ version: 0.1.0
|
|||||||
keywords:
|
keywords:
|
||||||
- shipyard
|
- shipyard
|
||||||
- airflow
|
- airflow
|
||||||
home: https://github.com/att-comdev/shipyard
|
home: https://github.com/openstack/airship-shipyard
|
||||||
sources:
|
sources:
|
||||||
- https://github.com/apache/incubator-airflow
|
- https://github.com/apache/incubator-airflow
|
||||||
- https://github.com/att-comdev/aic-helm
|
- https://github.com/openstack/airship-shipyard/tree/master/charts/shipyard
|
||||||
- https://git.openstack.org/cgit/openstack/openstack-helm
|
- https://git.openstack.org/cgit/openstack/openstack-helm
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: OpenStack-Helm Authors
|
- name: Airship
|
||||||
engine: gotpl
|
engine: gotpl
|
||||||
|
@ -31,13 +31,13 @@ labels:
|
|||||||
|
|
||||||
images:
|
images:
|
||||||
tags:
|
tags:
|
||||||
airflow: quay.io/attcomdev/airflow:latest
|
airflow: quay.io/airshipit/airflow:latest
|
||||||
shipyard: quay.io/attcomdev/shipyard:latest
|
shipyard: quay.io/airshipit/shipyard:latest
|
||||||
dep_check: quay.io/stackanetes/kubernetes-entrypoint:v0.3.1
|
dep_check: quay.io/stackanetes/kubernetes-entrypoint:v0.3.1
|
||||||
shipyard_db_init: docker.io/postgres:9.5
|
shipyard_db_init: docker.io/postgres:9.5
|
||||||
shipyard_db_sync: quay.io/attcomdev/shipyard:latest
|
shipyard_db_sync: quay.io/airshipit/shipyard:latest
|
||||||
airflow_db_init: docker.io/postgres:9.5
|
airflow_db_init: docker.io/postgres:9.5
|
||||||
airflow_db_sync: quay.io/attcomdev/airflow:latest
|
airflow_db_sync: quay.io/airshipit/airflow:latest
|
||||||
ks_user: docker.io/openstackhelm/heat:ocata
|
ks_user: docker.io/openstackhelm/heat:ocata
|
||||||
ks_service: docker.io/openstackhelm/heat:ocata
|
ks_service: docker.io/openstackhelm/heat:ocata
|
||||||
ks_endpoints: docker.io/openstackhelm/heat:ocata
|
ks_endpoints: docker.io/openstackhelm/heat:ocata
|
||||||
|
@ -342,8 +342,8 @@ Action API
|
|||||||
----------
|
----------
|
||||||
The Shipyard Action API is a resource that allows for creation, control and
|
The Shipyard Action API is a resource that allows for creation, control and
|
||||||
investigation of triggered workflows. These actions encapsulate a command
|
investigation of triggered workflows. These actions encapsulate a command
|
||||||
interface for the Undercloud Platform. See :ref:`shipyard_action_commands` for
|
interface for the Airship Undercloud Platform. See
|
||||||
supported actions
|
:ref:`shipyard_action_commands` for supported actions
|
||||||
|
|
||||||
/v1.0/actions
|
/v1.0/actions
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
@ -99,7 +99,7 @@
|
|||||||
# From shipyard_api
|
# From shipyard_api
|
||||||
#
|
#
|
||||||
|
|
||||||
# Namespace of UCP Pods (string value)
|
# Namespace of Airship Pods (string value)
|
||||||
#ucp_namespace = ucp
|
#ucp_namespace = ucp
|
||||||
|
|
||||||
|
|
||||||
@ -363,10 +363,10 @@
|
|||||||
# (integer value)
|
# (integer value)
|
||||||
#deckhand_client_read_timeout = 300
|
#deckhand_client_read_timeout = 300
|
||||||
|
|
||||||
# UCP component validation connect timeout (in seconds) (integer value)
|
# Airship component validation connect timeout (in seconds) (integer value)
|
||||||
#validation_connect_timeout = 5
|
#validation_connect_timeout = 5
|
||||||
|
|
||||||
# UCP component validation timeout (in seconds) (integer value)
|
# Airship component validation timeout (in seconds) (integer value)
|
||||||
#validation_read_timeout = 300
|
#validation_read_timeout = 300
|
||||||
|
|
||||||
|
|
||||||
|
@ -115,7 +115,7 @@ Prerequisites:
|
|||||||
|
|
||||||
``Retrieve Shipyard client software from git``::
|
``Retrieve Shipyard client software from git``::
|
||||||
|
|
||||||
git clone --depth=1 https://github.com/att-comdev/shipyard.git
|
git clone --depth=1 https://github.com/openstack/airship-shipyard.git
|
||||||
|
|
||||||
``Install requirements``::
|
``Install requirements``::
|
||||||
|
|
||||||
@ -184,7 +184,7 @@ command. In this example we will execute the ``get actions`` command::
|
|||||||
-e 'OS_PASSWORD=password' -e 'OS_PROJECT_DOMAIN_NAME=default' \
|
-e 'OS_PASSWORD=password' -e 'OS_PROJECT_DOMAIN_NAME=default' \
|
||||||
-e 'OS_PROJECT_NAME=service' -e 'OS_USERNAME=shipyard' \
|
-e 'OS_PROJECT_NAME=service' -e 'OS_USERNAME=shipyard' \
|
||||||
-e 'OS_USER_DOMAIN_NAME=default' -e 'OS_IDENTITY_API_VERSION=3' \
|
-e 'OS_USER_DOMAIN_NAME=default' -e 'OS_IDENTITY_API_VERSION=3' \
|
||||||
--rm --net=host attcomdev/shipyard:latest get actions
|
--rm --net=host airshipit/shipyard:latest get actions
|
||||||
|
|
||||||
The output will resemble the following::
|
The output will resemble the following::
|
||||||
|
|
||||||
|
@ -615,7 +615,7 @@ An Example of CLI `describe action` command output, with failed processing::
|
|||||||
step/01BZZK07NF04XPC5F4SCTHNPKN/drydock_nodes 6 failed
|
step/01BZZK07NF04XPC5F4SCTHNPKN/drydock_nodes 6 failed
|
||||||
|
|
||||||
|
|
||||||
.. _`Armada manifest document`: https://airshipit.readthedocs.io/projects/armada/en/latest/operations/guide-build-armada-yaml.html?highlight=manifest
|
.. _`Armada manifest document`: https://airship-armada.readthedocs.io/en/latest/operations/guide-build-armada-yaml.html?highlight=manifest
|
||||||
.. _`Default configuration values`: https://git.airshipit.org/cgit/airship-shipyard/tree/src/bin/shipyard_airflow/shipyard_airflow/plugins/deployment_configuration_operator.py
|
.. _`Default configuration values`: https://git.airshipit.org/cgit/airship-shipyard/tree/src/bin/shipyard_airflow/shipyard_airflow/plugins/deployment_configuration_operator.py
|
||||||
.. _DeploymentConfiguration: https://git.airshipit.org/cgit/airship-shipyard/tree/src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentConfiguration.yaml
|
.. _DeploymentConfiguration: https://git.airshipit.org/cgit/airship-shipyard/tree/src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentConfiguration.yaml
|
||||||
.. _DeploymentStrategy: https://git.airshipit.org/cgit/airship-shipyard/tree/src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentStrategy.yaml
|
.. _DeploymentStrategy: https://git.airshipit.org/cgit/airship-shipyard/tree/src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentStrategy.yaml
|
||||||
|
@ -22,8 +22,8 @@ apache-airflow[crypto,celery,postgres,hive,hdfs,jdbc]==1.9.0
|
|||||||
python-openstackclient==3.11.0
|
python-openstackclient==3.11.0
|
||||||
kubernetes>=6.0.0
|
kubernetes>=6.0.0
|
||||||
|
|
||||||
# Dependencies for other UCP components
|
# Dependencies for other Airship components
|
||||||
git+https://git.openstack.org/openstack/airship-deckhand@177675e96fffcda9799c68bbce831424c1167020#egg=deckhand
|
git+https://git.openstack.org/openstack/airship-deckhand@177675e96fffcda9799c68bbce831424c1167020#egg=deckhand
|
||||||
git+https://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
|
git+https://github.com/openstack/airship-drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
|
||||||
git+https://github.com/att-comdev/armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada
|
git+https://github.com/openstack/airship-armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada
|
||||||
|
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
# Shipyard
|
# Shipyard
|
||||||
Shipyard is the directed acyclic graph controller for Kubernetes and
|
Shipyard is the directed acyclic graph controller for Kubernetes and
|
||||||
OpenStack control plane life cycle management, and a component of the
|
OpenStack control plane life cycle management, and a component of the
|
||||||
Undercloud Platform (UCP).
|
Airship Undercloud Platform (UCP).
|
||||||
|
|
||||||
Shipyard provides the entrypoint for the following aspects of the
|
Shipyard provides the entrypoint for the following aspects of the
|
||||||
control plane established by the UCP:
|
control plane established by the Airship:
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt>
|
<dt>
|
||||||
@ -14,10 +14,10 @@ control plane established by the UCP:
|
|||||||
Site designs, including the configuration of bare metal host
|
Site designs, including the configuration of bare metal host
|
||||||
nodes, network design, operating systems, Kubernetes nodes,
|
nodes, network design, operating systems, Kubernetes nodes,
|
||||||
Armada manifests, Helm charts, and any other descriptors that
|
Armada manifests, Helm charts, and any other descriptors that
|
||||||
define the build out of a group of servers enter the UCP via
|
define the build out of a group of servers enter the Airship via
|
||||||
Shipyard. Secrets, such as passwords and certificates use the
|
Shipyard. Secrets, such as passwords and certificates use the
|
||||||
same mechanism. <br />
|
same mechanism. <br />
|
||||||
The designs and secrets are stored in UCP's Deckhand,
|
The designs and secrets are stored in Airship's Deckhand,
|
||||||
providing for version history and secure storage among other
|
providing for version history and secure storage among other
|
||||||
document-based conveniences.
|
document-based conveniences.
|
||||||
</dd>
|
</dd>
|
||||||
@ -34,7 +34,7 @@ control plane established by the UCP:
|
|||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
Find more documentation for Shipyard on
|
Find more documentation for Shipyard on
|
||||||
[Read the Docs](http://shipyard.readthedocs.io/en/latest/)
|
[Read the Docs](https://airship-shipyard.readthedocs.io)
|
||||||
|
|
||||||
|
|
||||||
## Integration Points:
|
## Integration Points:
|
||||||
@ -48,26 +48,26 @@ framework and automation of workflows provided by Shipyard
|
|||||||
information to correlate workflows with users and history of workflow
|
information to correlate workflows with users and history of workflow
|
||||||
commands
|
commands
|
||||||
\
|
\
|
||||||
[Deckhand](https://github.com/att-comdev/deckhand) supplies storage
|
[Deckhand](https://github.com/openstack/airship-deckhand) supplies storage
|
||||||
and management of site designs and secrets
|
and management of site designs and secrets
|
||||||
\
|
\
|
||||||
[Drydock](https://github.com/att-comdev/drydock) is orchestrated by
|
[Drydock](https://github.com/openstack/airship-drydock) is orchestrated by
|
||||||
Shipyard to perform bare metal node provisioning
|
Shipyard to perform bare metal node provisioning
|
||||||
\
|
\
|
||||||
[Promenade](https://github.com/att-comdev/promenade) is indirectly
|
[Promenade](https://github.com/openstack/airship-promenade) is indirectly
|
||||||
orchestrated by Shipyard to configure and join Kubernetes nodes
|
orchestrated by Shipyard to configure and join Kubernetes nodes
|
||||||
\
|
\
|
||||||
[Armada](https://github.com/att-comdev/armada) is orchestrated by
|
[Armada](https://github.com/openstack/airship-armada) is orchestrated by
|
||||||
Shipyard to deploy and test Kubernetes workloads
|
Shipyard to deploy and test Kubernetes workloads
|
||||||
|
|
||||||
|
|
||||||
## Getting Started:
|
## Getting Started:
|
||||||
|
|
||||||
[Shipyard @ Gerrithub](https://review.gerrithub.io/#/q/project:att-comdev/shipyard)
|
[Shipyard @ Openstack Gerrit](https://review.openstack.org/#/q/project:openstack/airship-shipyard)
|
||||||
\
|
\
|
||||||
[Helm chart](https://github.com/att-comdev/aic-helm/tree/master/shipyard)
|
[Helm chart](https://github.com/openstack/airship-shipyard/tree/master/charts/shipyard)
|
||||||
|
|
||||||
|
|
||||||
## See also:
|
## See also:
|
||||||
|
|
||||||
[Undercloud Platform (UCP)](https://github.com/att-comdev/ucp-integration)
|
[Airship in a Bottle](https://github.com/openstack/airship-in-a-bottle)
|
||||||
|
@ -99,7 +99,7 @@
|
|||||||
# From shipyard_api
|
# From shipyard_api
|
||||||
#
|
#
|
||||||
|
|
||||||
# Namespace of UCP Pods (string value)
|
# Namespace of Airship Pods (string value)
|
||||||
#ucp_namespace = ucp
|
#ucp_namespace = ucp
|
||||||
|
|
||||||
|
|
||||||
@ -363,10 +363,10 @@
|
|||||||
# (integer value)
|
# (integer value)
|
||||||
#deckhand_client_read_timeout = 300
|
#deckhand_client_read_timeout = 300
|
||||||
|
|
||||||
# UCP component validation connect timeout (in seconds) (integer value)
|
# Airship component validation connect timeout (in seconds) (integer value)
|
||||||
#validation_connect_timeout = 5
|
#validation_connect_timeout = 5
|
||||||
|
|
||||||
# UCP component validation timeout (in seconds) (integer value)
|
# Airship component validation timeout (in seconds) (integer value)
|
||||||
#validation_read_timeout = 300
|
#validation_read_timeout = 300
|
||||||
|
|
||||||
|
|
||||||
|
@ -35,6 +35,6 @@ SQLAlchemy==1.2.8
|
|||||||
ulid==1.1
|
ulid==1.1
|
||||||
uwsgi==2.0.15
|
uwsgi==2.0.15
|
||||||
|
|
||||||
# Dependencies for other UCP components
|
# Dependencies for other Airship components
|
||||||
git+https://git.openstack.org/openstack/airship-deckhand@177675e96fffcda9799c68bbce831424c1167020#egg=deckhand
|
git+https://git.openstack.org/openstack/airship-deckhand@177675e96fffcda9799c68bbce831424c1167020#egg=deckhand
|
||||||
git+https://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
|
git+https://github.com/openstack/airship-drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
|
||||||
|
@ -11,6 +11,7 @@
|
|||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
import setuptools
|
import setuptools
|
||||||
|
|
||||||
setuptools.setup(
|
setuptools.setup(
|
||||||
@ -18,8 +19,8 @@ setuptools.setup(
|
|||||||
version='0.1a1',
|
version='0.1a1',
|
||||||
description=('Directed acyclic graph controller for Kubernetes and '
|
description=('Directed acyclic graph controller for Kubernetes and '
|
||||||
'OpenStack control plane life cycle management'),
|
'OpenStack control plane life cycle management'),
|
||||||
url='https://github.com/att-comdev/shipyard',
|
url='https://github.com/openstack/airship-shipyard',
|
||||||
author='AT&T - AIC UCP Developers',
|
author='AT&T - Airship Developers',
|
||||||
license='Apache 2.0',
|
license='Apache 2.0',
|
||||||
packages=setuptools.find_packages(),
|
packages=setuptools.find_packages(),
|
||||||
entry_points={
|
entry_points={
|
||||||
|
@ -88,7 +88,7 @@ class DocumentValidator(metaclass=abc.ABCMeta):
|
|||||||
:param diagnostic: Possible solutions or troubleshooting. Defaults to
|
:param diagnostic: Possible solutions or troubleshooting. Defaults to
|
||||||
a generic message about being generated by Shipyard
|
a generic message about being generated by Shipyard
|
||||||
In accordance with:
|
In accordance with:
|
||||||
https://github.com/att-comdev/ucp-integration/blob/master/docs/source/api-conventions.rst#validationmessage-message-type
|
https://github.com/openstack/airship-in-a-bottle/blob/master/doc/source/api-conventions.rst#validationmessage-message-type
|
||||||
"""
|
"""
|
||||||
if documents is None:
|
if documents is None:
|
||||||
documents = [{"schema": self.schema, "name": self.doc_name}]
|
documents = [{"schema": self.schema, "name": self.doc_name}]
|
||||||
|
@ -220,12 +220,13 @@ SECTIONS = [
|
|||||||
cfg.IntOpt(
|
cfg.IntOpt(
|
||||||
'validation_connect_timeout',
|
'validation_connect_timeout',
|
||||||
default=5,
|
default=5,
|
||||||
help='UCP component validation connect timeout (in seconds)'
|
help=('Airship component validation connect timeout '
|
||||||
|
'(in seconds)')
|
||||||
),
|
),
|
||||||
cfg.IntOpt(
|
cfg.IntOpt(
|
||||||
'validation_read_timeout',
|
'validation_read_timeout',
|
||||||
default=300,
|
default=300,
|
||||||
help='UCP component validation timeout (in seconds)'
|
help='Airship component validation timeout (in seconds)'
|
||||||
),
|
),
|
||||||
]
|
]
|
||||||
),
|
),
|
||||||
@ -252,7 +253,7 @@ SECTIONS = [
|
|||||||
cfg.StrOpt(
|
cfg.StrOpt(
|
||||||
'ucp_namespace',
|
'ucp_namespace',
|
||||||
default='ucp',
|
default='ucp',
|
||||||
help='Namespace of UCP Pods'
|
help='Namespace of Airship Pods'
|
||||||
),
|
),
|
||||||
]
|
]
|
||||||
),
|
),
|
||||||
|
@ -182,7 +182,7 @@ class CommitConfigDocsResource(BaseResource):
|
|||||||
@api_lock(ApiLockType.CONFIGDOCS_UPDATE)
|
@api_lock(ApiLockType.CONFIGDOCS_UPDATE)
|
||||||
def on_post(self, req, resp):
|
def on_post(self, req, resp):
|
||||||
"""
|
"""
|
||||||
Get validations from all UCP components
|
Get validations from all Airship components
|
||||||
Functionality does not exist yet
|
Functionality does not exist yet
|
||||||
"""
|
"""
|
||||||
# force and dryrun query parameter is False unless explicitly true
|
# force and dryrun query parameter is False unless explicitly true
|
||||||
|
@ -409,7 +409,7 @@ class ConfigdocsHelper(object):
|
|||||||
retry=False)
|
retry=False)
|
||||||
|
|
||||||
def _get_validations_from_ucp_components(self, revision_id):
|
def _get_validations_from_ucp_components(self, revision_id):
|
||||||
"""Invoke other UCP components to retrieve their validations"""
|
"""Invoke other Airship components to retrieve their validations"""
|
||||||
resp_msgs = []
|
resp_msgs = []
|
||||||
error_count = 0
|
error_count = 0
|
||||||
design_ref = DesignRefHelper().get_design_reference(revision_id)
|
design_ref = DesignRefHelper().get_design_reference(revision_id)
|
||||||
@ -456,11 +456,12 @@ class ConfigdocsHelper(object):
|
|||||||
|
|
||||||
Invokes Deckhand to render the revision, which will either succeed, or
|
Invokes Deckhand to render the revision, which will either succeed, or
|
||||||
fail and return validaiton failures. If there are any failures, the
|
fail and return validaiton failures. If there are any failures, the
|
||||||
process will not proceed to validate against the other UCP components.
|
process will not proceed to validate against the other Airship
|
||||||
|
components.
|
||||||
Upon success from Deckhand rendering, uses the endpoints for each of
|
Upon success from Deckhand rendering, uses the endpoints for each of
|
||||||
the UCP components to validate the version indicated.
|
the Airship components to validate the version indicated.
|
||||||
Responds in the format defined here:
|
Responds in the format defined here:
|
||||||
https://github.com/att-comdev/ucp-integration/blob/master/docs/api-conventions.md#post-v10validatedesign
|
https://github.com/openstack/airship-in-a-bottle/blob/master/doc/source/api-conventions.rst#post-v10validatedesign
|
||||||
"""
|
"""
|
||||||
resp_msgs = []
|
resp_msgs = []
|
||||||
error_count = 0
|
error_count = 0
|
||||||
@ -491,7 +492,7 @@ class ConfigdocsHelper(object):
|
|||||||
revision_id)
|
revision_id)
|
||||||
resp_msgs.extend(cpnt_msgs)
|
resp_msgs.extend(cpnt_msgs)
|
||||||
error_count += cpnt_ec
|
error_count += cpnt_ec
|
||||||
LOG.debug("UCP component validations: %s", cpnt_ec)
|
LOG.debug("Airship component validations: %s", cpnt_ec)
|
||||||
|
|
||||||
# return the formatted status response
|
# return the formatted status response
|
||||||
return _format_validations_to_status(resp_msgs, error_count)
|
return _format_validations_to_status(resp_msgs, error_count)
|
||||||
|
@ -31,7 +31,7 @@ def all_preflight_checks(parent_dag_name, child_dag_name, args):
|
|||||||
default_args=args)
|
default_args=args)
|
||||||
|
|
||||||
'''
|
'''
|
||||||
Check that all UCP components are in good state for the purposes
|
Check that all Airship components are in good state for the purposes
|
||||||
of the Undercloud Platform to proceed with processing.
|
of the Undercloud Platform to proceed with processing.
|
||||||
'''
|
'''
|
||||||
shipyard = UcpHealthCheckOperator(
|
shipyard = UcpHealthCheckOperator(
|
||||||
|
@ -36,7 +36,7 @@ SOFTWARE = 'software'
|
|||||||
|
|
||||||
|
|
||||||
def validate_site_design(parent_dag_name, child_dag_name, args, targets=None):
|
def validate_site_design(parent_dag_name, child_dag_name, args, targets=None):
|
||||||
"""Subdag to delegate design verification to the UCP components
|
"""Subdag to delegate design verification to the Airship components
|
||||||
|
|
||||||
There is no wiring of steps - they all execute in parallel
|
There is no wiring of steps - they all execute in parallel
|
||||||
"""
|
"""
|
||||||
|
@ -43,7 +43,7 @@ class DeckhandClientFactory(object):
|
|||||||
Notes:
|
Notes:
|
||||||
TODO(bryan-strassner): If/when the airflow plugin modules move to using
|
TODO(bryan-strassner): If/when the airflow plugin modules move to using
|
||||||
oslo config, consider using the example here:
|
oslo config, consider using the example here:
|
||||||
https://github.com/att-comdev/deckhand/blob/cef3b52a104e620e88a24caf70ed2bb1297c268f/deckhand/barbican/client_wrapper.py#L53
|
https://github.com/openstack/airship-deckhand/blob/cef3b52a104e620e88a24caf70ed2bb1297c268f/deckhand/barbican/client_wrapper.py#L53
|
||||||
which will load the attributes from the config more flexibly.
|
which will load the attributes from the config more flexibly.
|
||||||
Keystoneauth1 also provides for a simpler solution with:
|
Keystoneauth1 also provides for a simpler solution with:
|
||||||
https://docs.openstack.org/keystoneauth/latest/api/keystoneauth1.loading.html
|
https://docs.openstack.org/keystoneauth/latest/api/keystoneauth1.loading.html
|
||||||
|
@ -261,7 +261,7 @@ class DrydockBaseOperator(UcpBaseOperator):
|
|||||||
Raises DrydockClientUseFailureException if the client raises an
|
Raises DrydockClientUseFailureException if the client raises an
|
||||||
exception
|
exception
|
||||||
See:
|
See:
|
||||||
http://att-comdev-drydock.readthedocs.io/en/latest/task.html#task-status-schema
|
https://airship-drydock.readthedocs.io/en/latest/task.html#task-status-schema
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
return self.drydock_client.get_task(task_id=task_id)
|
return self.drydock_client.get_task(task_id=task_id)
|
||||||
@ -376,7 +376,7 @@ class DrydockBaseOperator(UcpBaseOperator):
|
|||||||
Raises DrydockClientUseFailureException if the client raises an
|
Raises DrydockClientUseFailureException if the client raises an
|
||||||
exception
|
exception
|
||||||
See:
|
See:
|
||||||
https://att-comdev-drydock.readthedocs.io/en/latest/API.html
|
https://airship-drydock.readthedocs.io/en/latest/API.html
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
return self.drydock_client.get_nodes()
|
return self.drydock_client.get_nodes()
|
||||||
|
@ -27,7 +27,7 @@ except ImportError:
|
|||||||
def shipyard_service_token(func):
|
def shipyard_service_token(func):
|
||||||
@wraps(func)
|
@wraps(func)
|
||||||
def keystone_token_get(self, *args):
|
def keystone_token_get(self, *args):
|
||||||
"""This function retrieves Keystone token for UCP Services
|
"""This function retrieves Keystone token for Airship Services
|
||||||
|
|
||||||
:param context: Information on the current workflow
|
:param context: Information on the current workflow
|
||||||
|
|
||||||
|
@ -44,9 +44,9 @@ LOG = logging.getLogger(__name__)
|
|||||||
|
|
||||||
class UcpBaseOperator(BaseOperator):
|
class UcpBaseOperator(BaseOperator):
|
||||||
|
|
||||||
"""UCP Base Operator
|
"""Airship Base Operator
|
||||||
|
|
||||||
All UCP related workflow operators will use the UCP base
|
All Airship related workflow operators will use the Airship base
|
||||||
operator as the parent and inherit attributes and methods
|
operator as the parent and inherit attributes and methods
|
||||||
from this class
|
from this class
|
||||||
|
|
||||||
@ -95,7 +95,7 @@ class UcpBaseOperator(BaseOperator):
|
|||||||
self.doc_utils = _get_document_util(self.shipyard_conf)
|
self.doc_utils = _get_document_util(self.shipyard_conf)
|
||||||
self.endpoints = service_endpoint.ServiceEndpoints(self.shipyard_conf)
|
self.endpoints = service_endpoint.ServiceEndpoints(self.shipyard_conf)
|
||||||
|
|
||||||
# Execute UCP base function
|
# Execute Airship base function
|
||||||
self.ucp_base(context)
|
self.ucp_base(context)
|
||||||
|
|
||||||
# Execute base function
|
# Execute base function
|
||||||
@ -107,7 +107,7 @@ class UcpBaseOperator(BaseOperator):
|
|||||||
|
|
||||||
def ucp_base(self, context):
|
def ucp_base(self, context):
|
||||||
|
|
||||||
LOG.info("Running UCP Base Operator...")
|
LOG.info("Running Airship Base Operator...")
|
||||||
|
|
||||||
# Read and parse shiyard.conf
|
# Read and parse shiyard.conf
|
||||||
config = configparser.ConfigParser()
|
config = configparser.ConfigParser()
|
||||||
|
@ -34,7 +34,7 @@ LOG = logging.getLogger(__name__)
|
|||||||
|
|
||||||
class UcpHealthCheckOperator(BaseOperator):
|
class UcpHealthCheckOperator(BaseOperator):
|
||||||
"""
|
"""
|
||||||
UCP Health Checks
|
Airship Health Checks
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@apply_defaults
|
@apply_defaults
|
||||||
@ -72,7 +72,7 @@ class UcpHealthCheckOperator(BaseOperator):
|
|||||||
# Set up xcom_pusher to push values to xcom
|
# Set up xcom_pusher to push values to xcom
|
||||||
self.xcom_pusher = XcomPusher(self.task_instance)
|
self.xcom_pusher = XcomPusher(self.task_instance)
|
||||||
|
|
||||||
# Loop through various UCP Components
|
# Loop through various Airship Components
|
||||||
for component in ucp_components:
|
for component in ucp_components:
|
||||||
|
|
||||||
# Retrieve Endpoint Information
|
# Retrieve Endpoint Information
|
||||||
|
@ -7,7 +7,7 @@ metadata:
|
|||||||
application: shipyard
|
application: shipyard
|
||||||
data:
|
data:
|
||||||
$schema: 'http://json-schema.org/schema#'
|
$schema: 'http://json-schema.org/schema#'
|
||||||
id: 'https://github.com/att-comdev/shipyard/deploymentConfiguration.yaml'
|
id: 'https://github.com/openstack/airship-shipyard/blob/master/src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentConfiguration.yaml'
|
||||||
type: 'object'
|
type: 'object'
|
||||||
properties:
|
properties:
|
||||||
physical_provisioner:
|
physical_provisioner:
|
||||||
|
@ -7,7 +7,7 @@ metadata:
|
|||||||
application: shipyard
|
application: shipyard
|
||||||
data:
|
data:
|
||||||
$schema: 'http://json-schema.org/schema#'
|
$schema: 'http://json-schema.org/schema#'
|
||||||
id: 'https://github.com/att-comdev/shipyard/deploymentStrategy.yaml'
|
id: 'https://github.com/openstack/airship-shipyard/blob/master/src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentStrategy.yaml'
|
||||||
type: 'object'
|
type: 'object'
|
||||||
required:
|
required:
|
||||||
- groups
|
- groups
|
||||||
|
@ -5,13 +5,13 @@ responses==0.8.1
|
|||||||
testfixtures==5.1.1
|
testfixtures==5.1.1
|
||||||
apache-airflow[crypto,celery,postgres,hive,hdfs,jdbc]==1.9.0
|
apache-airflow[crypto,celery,postgres,hive,hdfs,jdbc]==1.9.0
|
||||||
|
|
||||||
# Testing - Client libraries for UCP components
|
# Testing - Client libraries for Airship components
|
||||||
git+https://github.com/att-comdev/deckhand.git@3cdf3d2d896d43c6e3bc26170522c3eee0d7158f#egg=deckhand
|
git+https://github.com/openstack/airship-deckhand.git@3cdf3d2d896d43c6e3bc26170522c3eee0d7158f#egg=deckhand
|
||||||
git+https://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
|
git+https://github.com/openstack/airship-drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
|
||||||
git+https://github.com/att-comdev/armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada
|
git+https://github.com/openstack/airship-armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada
|
||||||
# TODO(bryan-strassner) Pin to version for airflow when added to the
|
# TODO(bryan-strassner) Pin to version for airflow when added to the
|
||||||
# requirements.txt in the airflow images directory
|
# requirements.txt in the airflow images directory
|
||||||
git+https://github.com/att-comdev/promenade.git@master#egg=promenade
|
git+https://github.com/openstack/airship-promenade.git@master#egg=promenade
|
||||||
|
|
||||||
|
|
||||||
# Linting
|
# Linting
|
||||||
|
@ -2,16 +2,16 @@
|
|||||||
A CLI for using a deployed Shipyard API.
|
A CLI for using a deployed Shipyard API.
|
||||||
|
|
||||||
Find more documentation for Shipyard on
|
Find more documentation for Shipyard on
|
||||||
[Read the Docs](https://airshipit.readthedocs.io/projects/shipyard/en/latest/)
|
[Read the Docs](https://airship-shipyard.readthedocs.io/)
|
||||||
|
|
||||||
|
|
||||||
## Getting Started:
|
## Getting Started:
|
||||||
|
|
||||||
[Shipyard @ Gerrithub](https://review.gerrithub.io/#/q/project:att-comdev/shipyard)
|
[Shipyard @ Openstack Gerrit](https://review.openstack.org/#/q/project:openstack/airship-shipyard)
|
||||||
\
|
\
|
||||||
[Helm chart](https://github.com/att-comdev/aic-helm/tree/master/shipyard)
|
[Helm chart](https://github.com/openstack/airship-shipyard/tree/master/charts/shipyard)
|
||||||
|
|
||||||
|
|
||||||
## See also:
|
## See also:
|
||||||
|
|
||||||
[Undercloud Platform (UCP)](https://github.com/att-comdev/ucp-integration)
|
[Airship in a Bottle](https://github.com/openstack/airship-in-a-bottle)
|
||||||
|
@ -11,14 +11,15 @@
|
|||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
import setuptools
|
import setuptools
|
||||||
|
|
||||||
setuptools.setup(
|
setuptools.setup(
|
||||||
name='shipyard_client',
|
name='shipyard_client',
|
||||||
version='0.1a1',
|
version='0.1a1',
|
||||||
description='CLI for Shipyard',
|
description='CLI for Shipyard',
|
||||||
url='https://github.com/att-comdev/shipyard',
|
url='https://github.com/openstack/airship-shipyard',
|
||||||
author='AT&T - AIC UCP Developers',
|
author='AT&T - Airship Developers',
|
||||||
license='Apache 2.0',
|
license='Apache 2.0',
|
||||||
packages=setuptools.find_packages(),
|
packages=setuptools.find_packages(),
|
||||||
entry_points={
|
entry_points={
|
||||||
|
@ -109,7 +109,7 @@ class ShipyardClient(BaseClient):
|
|||||||
"""
|
"""
|
||||||
:param force: boolean, True|False
|
:param force: boolean, True|False
|
||||||
:param dryrun: boolean, True|False
|
:param dryrun: boolean, True|False
|
||||||
:returns: dictionary, validations from UCP components
|
:returns: dictionary, validations from Airship components
|
||||||
:rtype: Response object
|
:rtype: Response object
|
||||||
"""
|
"""
|
||||||
query_params = {"force": force, "dryrun": dryrun}
|
query_params = {"force": force, "dryrun": dryrun}
|
||||||
|
@ -100,7 +100,7 @@ def cli_format_status_handler(response, is_error=False):
|
|||||||
|
|
||||||
# Map of levels by severity. Extra values are included in this map but valid
|
# Map of levels by severity. Extra values are included in this map but valid
|
||||||
# values are defined here:
|
# values are defined here:
|
||||||
# https://github.com/att-comdev/ucp-integration/blob/master/docs/source/api-conventions.rst#validationmessage-message-type
|
# https://github.com/openstack/airship-in-a-bottle/blob/master/doc/source/api-conventions.rst#validationmessage-message-type
|
||||||
_LEVEL_KEYS = {
|
_LEVEL_KEYS = {
|
||||||
0: ['error', 'fatal'],
|
0: ['error', 'fatal'],
|
||||||
1: ['warn', 'warning'],
|
1: ['warn', 'warning'],
|
||||||
|
@ -66,7 +66,7 @@ create configdocs ${collection} --replace --directory=/target
|
|||||||
# Following the creation of a configdocs collection in the Shipyard buffer,
|
# Following the creation of a configdocs collection in the Shipyard buffer,
|
||||||
# the configdocs must be committed before Shipyard is able to use them as
|
# the configdocs must be committed before Shipyard is able to use them as
|
||||||
# part of an action.
|
# part of an action.
|
||||||
# The other UCP components will be contacted to validate the designs in
|
# The other Airship components will be contacted to validate the designs in
|
||||||
# Deckhand when 'commit configdocs' command is executed. Shipyard will
|
# Deckhand when 'commit configdocs' command is executed. Shipyard will
|
||||||
# only mark the revision as committed if the validations are successful
|
# only mark the revision as committed if the validations are successful
|
||||||
echo -e "Committing Configdocs..."
|
echo -e "Committing Configdocs..."
|
||||||
|
Loading…
x
Reference in New Issue
Block a user