Browse Source

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
changes/34/604434/4
Roman Gorshunov 2 years ago
parent
commit
7fa3136470
32 changed files with 81 additions and 77 deletions
  1. +1
    -1
      .editorconfig
  2. +1
    -1
      README.rst
  3. +3
    -3
      charts/shipyard/Chart.yaml
  4. +4
    -4
      charts/shipyard/values.yaml
  5. +2
    -2
      doc/source/API.rst
  6. +3
    -3
      doc/source/_static/shipyard.conf.sample
  7. +2
    -2
      doc/source/client-user-guide.rst
  8. +1
    -1
      doc/source/site-definition-documents.rst
  9. +3
    -3
      images/airflow/requirements.txt
  10. +12
    -12
      src/bin/shipyard_airflow/README.md
  11. +3
    -3
      src/bin/shipyard_airflow/etc/shipyard/shipyard.conf.sample
  12. +2
    -2
      src/bin/shipyard_airflow/requirements.txt
  13. +3
    -2
      src/bin/shipyard_airflow/setup.py
  14. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/common/document_validators/document_validator.py
  15. +4
    -3
      src/bin/shipyard_airflow/shipyard_airflow/conf/config.py
  16. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/control/configdocs/configdocs_api.py
  17. +6
    -5
      src/bin/shipyard_airflow/shipyard_airflow/control/helpers/configdocs_helper.py
  18. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/dags/preflight_checks.py
  19. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/dags/validate_site_design.py
  20. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/plugins/deckhand_client_factory.py
  21. +2
    -2
      src/bin/shipyard_airflow/shipyard_airflow/plugins/drydock_base_operator.py
  22. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/plugins/service_token.py
  23. +4
    -4
      src/bin/shipyard_airflow/shipyard_airflow/plugins/ucp_base_operator.py
  24. +2
    -2
      src/bin/shipyard_airflow/shipyard_airflow/plugins/ucp_preflight_check_operator.py
  25. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentConfiguration.yaml
  26. +1
    -1
      src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentStrategy.yaml
  27. +5
    -5
      src/bin/shipyard_airflow/test-requirements.txt
  28. +4
    -4
      src/bin/shipyard_client/README.md
  29. +3
    -2
      src/bin/shipyard_client/setup.py
  30. +1
    -1
      src/bin/shipyard_client/shipyard_client/api_client/shipyard_api_client.py
  31. +1
    -1
      src/bin/shipyard_client/shipyard_client/cli/format_utils.py
  32. +1
    -1
      tools/deckhand_load_yaml.sh

+ 1
- 1
.editorconfig View File

@ -11,7 +11,7 @@ insert_final_newline = true
trim_trailing_whitespace = true
[*.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
max_line_length = 79


+ 1
- 1
README.rst View File

@ -51,5 +51,5 @@ If you find a bug, please feel free to create a `Storyboard issue`_.
.. _Promenade: https://github.com/openstack/airship-promenade
.. _Armada: https://github.com/openstack/airship-armada
.. _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

+ 3
- 3
charts/shipyard/Chart.yaml View File

@ -20,11 +20,11 @@ version: 0.1.0
keywords:
- shipyard
- airflow
home: https://github.com/att-comdev/shipyard
home: https://github.com/openstack/airship-shipyard
sources:
- 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
maintainers:
- name: OpenStack-Helm Authors
- name: Airship
engine: gotpl

+ 4
- 4
charts/shipyard/values.yaml View File

@ -31,13 +31,13 @@ labels:
images:
tags:
airflow: quay.io/attcomdev/airflow:latest
shipyard: quay.io/attcomdev/shipyard:latest
airflow: quay.io/airshipit/airflow:latest
shipyard: quay.io/airshipit/shipyard:latest
dep_check: quay.io/stackanetes/kubernetes-entrypoint:v0.3.1
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_sync: quay.io/attcomdev/airflow:latest
airflow_db_sync: quay.io/airshipit/airflow:latest
ks_user: docker.io/openstackhelm/heat:ocata
ks_service: docker.io/openstackhelm/heat:ocata
ks_endpoints: docker.io/openstackhelm/heat:ocata


+ 2
- 2
doc/source/API.rst View File

@ -342,8 +342,8 @@ Action API
----------
The Shipyard Action API is a resource that allows for creation, control and
investigation of triggered workflows. These actions encapsulate a command
interface for the Undercloud Platform. See :ref:`shipyard_action_commands` for
supported actions
interface for the Airship Undercloud Platform. See
:ref:`shipyard_action_commands` for supported actions
/v1.0/actions
~~~~~~~~~~~~~


+ 3
- 3
doc/source/_static/shipyard.conf.sample View File

@ -99,7 +99,7 @@
# From shipyard_api
#
# Namespace of UCP Pods (string value)
# Namespace of Airship Pods (string value)
#ucp_namespace = ucp
@ -363,10 +363,10 @@
# (integer value)
#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
# UCP component validation timeout (in seconds) (integer value)
# Airship component validation timeout (in seconds) (integer value)
#validation_read_timeout = 300


+ 2
- 2
doc/source/client-user-guide.rst View File

@ -115,7 +115,7 @@ Prerequisites:
``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``::
@ -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_PROJECT_NAME=service' -e 'OS_USERNAME=shipyard' \
-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::


+ 1
- 1
doc/source/site-definition-documents.rst View File

@ -615,7 +615,7 @@ An Example of CLI `describe action` command output, with failed processing::
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
.. _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


+ 3
- 3
images/airflow/requirements.txt View File

@ -22,8 +22,8 @@ apache-airflow[crypto,celery,postgres,hive,hdfs,jdbc]==1.9.0
python-openstackclient==3.11.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://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
git+https://github.com/att-comdev/armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada
git+https://github.com/openstack/airship-drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
git+https://github.com/openstack/airship-armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada

+ 12
- 12
src/bin/shipyard_airflow/README.md View File

@ -1,10 +1,10 @@
# Shipyard
Shipyard is the directed acyclic graph controller for Kubernetes and
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
control plane established by the UCP:
control plane established by the Airship:
<dl>
<dt>
@ -14,10 +14,10 @@ control plane established by the UCP:
Site designs, including the configuration of bare metal host
nodes, network design, operating systems, Kubernetes nodes,
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
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
document-based conveniences.
</dd>
@ -34,7 +34,7 @@ control plane established by the UCP:
</dl>
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:
@ -48,26 +48,26 @@ framework and automation of workflows provided by Shipyard
information to correlate workflows with users and history of workflow
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
\
[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
\
[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
\
[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
## 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:
[Undercloud Platform (UCP)](https://github.com/att-comdev/ucp-integration)
[Airship in a Bottle](https://github.com/openstack/airship-in-a-bottle)

+ 3
- 3
src/bin/shipyard_airflow/etc/shipyard/shipyard.conf.sample View File

@ -99,7 +99,7 @@
# From shipyard_api
#
# Namespace of UCP Pods (string value)
# Namespace of Airship Pods (string value)
#ucp_namespace = ucp
@ -363,10 +363,10 @@
# (integer value)
#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
# UCP component validation timeout (in seconds) (integer value)
# Airship component validation timeout (in seconds) (integer value)
#validation_read_timeout = 300


+ 2
- 2
src/bin/shipyard_airflow/requirements.txt View File

@ -35,6 +35,6 @@ SQLAlchemy==1.2.8
ulid==1.1
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://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
git+https://github.com/openstack/airship-drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner

+ 3
- 2
src/bin/shipyard_airflow/setup.py View File

@ -11,6 +11,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import setuptools
setuptools.setup(
@ -18,8 +19,8 @@ setuptools.setup(
version='0.1a1',
description=('Directed acyclic graph controller for Kubernetes and '
'OpenStack control plane life cycle management'),
url='https://github.com/att-comdev/shipyard',
author='AT&T - AIC UCP Developers',
url='https://github.com/openstack/airship-shipyard',
author='AT&T - Airship Developers',
license='Apache 2.0',
packages=setuptools.find_packages(),
entry_points={


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/common/document_validators/document_validator.py View File

@ -88,7 +88,7 @@ class DocumentValidator(metaclass=abc.ABCMeta):
:param diagnostic: Possible solutions or troubleshooting. Defaults to
a generic message about being generated by Shipyard
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:
documents = [{"schema": self.schema, "name": self.doc_name}]


+ 4
- 3
src/bin/shipyard_airflow/shipyard_airflow/conf/config.py View File

@ -220,12 +220,13 @@ SECTIONS = [
cfg.IntOpt(
'validation_connect_timeout',
default=5,
help='UCP component validation connect timeout (in seconds)'
help=('Airship component validation connect timeout '
'(in seconds)')
),
cfg.IntOpt(
'validation_read_timeout',
default=300,
help='UCP component validation timeout (in seconds)'
help='Airship component validation timeout (in seconds)'
),
]
),
@ -252,7 +253,7 @@ SECTIONS = [
cfg.StrOpt(
'ucp_namespace',
default='ucp',
help='Namespace of UCP Pods'
help='Namespace of Airship Pods'
),
]
),


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/control/configdocs/configdocs_api.py View File

@ -182,7 +182,7 @@ class CommitConfigDocsResource(BaseResource):
@api_lock(ApiLockType.CONFIGDOCS_UPDATE)
def on_post(self, req, resp):
"""
Get validations from all UCP components
Get validations from all Airship components
Functionality does not exist yet
"""
# force and dryrun query parameter is False unless explicitly true


+ 6
- 5
src/bin/shipyard_airflow/shipyard_airflow/control/helpers/configdocs_helper.py View File

@ -409,7 +409,7 @@ class ConfigdocsHelper(object):
retry=False)
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 = []
error_count = 0
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
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
the UCP components to validate the version indicated.
the Airship components to validate the version indicated.
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 = []
error_count = 0
@ -491,7 +492,7 @@ class ConfigdocsHelper(object):
revision_id)
resp_msgs.extend(cpnt_msgs)
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 _format_validations_to_status(resp_msgs, error_count)


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/dags/preflight_checks.py View File

@ -31,7 +31,7 @@ def all_preflight_checks(parent_dag_name, child_dag_name, 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.
'''
shipyard = UcpHealthCheckOperator(


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/dags/validate_site_design.py View File

@ -36,7 +36,7 @@ SOFTWARE = 'software'
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
"""


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/plugins/deckhand_client_factory.py View File

@ -43,7 +43,7 @@ class DeckhandClientFactory(object):
Notes:
TODO(bryan-strassner): If/when the airflow plugin modules move to using
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.
Keystoneauth1 also provides for a simpler solution with:
https://docs.openstack.org/keystoneauth/latest/api/keystoneauth1.loading.html


+ 2
- 2
src/bin/shipyard_airflow/shipyard_airflow/plugins/drydock_base_operator.py View File

@ -261,7 +261,7 @@ class DrydockBaseOperator(UcpBaseOperator):
Raises DrydockClientUseFailureException if the client raises an
exception
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:
return self.drydock_client.get_task(task_id=task_id)
@ -376,7 +376,7 @@ class DrydockBaseOperator(UcpBaseOperator):
Raises DrydockClientUseFailureException if the client raises an
exception
See:
https://att-comdev-drydock.readthedocs.io/en/latest/API.html
https://airship-drydock.readthedocs.io/en/latest/API.html
"""
try:
return self.drydock_client.get_nodes()


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/plugins/service_token.py View File

@ -27,7 +27,7 @@ except ImportError:
def shipyard_service_token(func):
@wraps(func)
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


+ 4
- 4
src/bin/shipyard_airflow/shipyard_airflow/plugins/ucp_base_operator.py View File

@ -44,9 +44,9 @@ LOG = logging.getLogger(__name__)
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
from this class
@ -95,7 +95,7 @@ class UcpBaseOperator(BaseOperator):
self.doc_utils = _get_document_util(self.shipyard_conf)
self.endpoints = service_endpoint.ServiceEndpoints(self.shipyard_conf)
# Execute UCP base function
# Execute Airship base function
self.ucp_base(context)
# Execute base function
@ -107,7 +107,7 @@ class UcpBaseOperator(BaseOperator):
def ucp_base(self, context):
LOG.info("Running UCP Base Operator...")
LOG.info("Running Airship Base Operator...")
# Read and parse shiyard.conf
config = configparser.ConfigParser()


+ 2
- 2
src/bin/shipyard_airflow/shipyard_airflow/plugins/ucp_preflight_check_operator.py View File

@ -34,7 +34,7 @@ LOG = logging.getLogger(__name__)
class UcpHealthCheckOperator(BaseOperator):
"""
UCP Health Checks
Airship Health Checks
"""
@apply_defaults
@ -72,7 +72,7 @@ class UcpHealthCheckOperator(BaseOperator):
# Set up xcom_pusher to push values to xcom
self.xcom_pusher = XcomPusher(self.task_instance)
# Loop through various UCP Components
# Loop through various Airship Components
for component in ucp_components:
# Retrieve Endpoint Information


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentConfiguration.yaml View File

@ -7,7 +7,7 @@ metadata:
application: shipyard
data:
$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'
properties:
physical_provisioner:


+ 1
- 1
src/bin/shipyard_airflow/shipyard_airflow/schemas/deploymentStrategy.yaml View File

@ -7,7 +7,7 @@ metadata:
application: shipyard
data:
$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'
required:
- groups


+ 5
- 5
src/bin/shipyard_airflow/test-requirements.txt View File

@ -5,13 +5,13 @@ responses==0.8.1
testfixtures==5.1.1
apache-airflow[crypto,celery,postgres,hive,hdfs,jdbc]==1.9.0
# Testing - Client libraries for UCP components
git+https://github.com/att-comdev/deckhand.git@3cdf3d2d896d43c6e3bc26170522c3eee0d7158f#egg=deckhand
git+https://github.com/att-comdev/drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
git+https://github.com/att-comdev/armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada
# Testing - Client libraries for Airship components
git+https://github.com/openstack/airship-deckhand.git@3cdf3d2d896d43c6e3bc26170522c3eee0d7158f#egg=deckhand
git+https://github.com/openstack/airship-drydock.git@8af92eaf29ca0dd6a129748c132ea7f6593eae83#egg=drydock_provisioner
git+https://github.com/openstack/airship-armada.git@7a2ba22ab12a3f1f180b6af4085972ba44853377#egg=armada
# TODO(bryan-strassner) Pin to version for airflow when added to the
# 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


+ 4
- 4
src/bin/shipyard_client/README.md View File

@ -2,16 +2,16 @@
A CLI for using a deployed Shipyard API.
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:
[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:
[Undercloud Platform (UCP)](https://github.com/att-comdev/ucp-integration)
[Airship in a Bottle](https://github.com/openstack/airship-in-a-bottle)

+ 3
- 2
src/bin/shipyard_client/setup.py View File

@ -11,14 +11,15 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import setuptools
setuptools.setup(
name='shipyard_client',
version='0.1a1',
description='CLI for Shipyard',
url='https://github.com/att-comdev/shipyard',
author='AT&T - AIC UCP Developers',
url='https://github.com/openstack/airship-shipyard',
author='AT&T - Airship Developers',
license='Apache 2.0',
packages=setuptools.find_packages(),
entry_points={


+ 1
- 1
src/bin/shipyard_client/shipyard_client/api_client/shipyard_api_client.py View File

@ -109,7 +109,7 @@ class ShipyardClient(BaseClient):
"""
:param force: boolean, True|False
:param dryrun: boolean, True|False
:returns: dictionary, validations from UCP components
:returns: dictionary, validations from Airship components
:rtype: Response object
"""
query_params = {"force": force, "dryrun": dryrun}


+ 1
- 1
src/bin/shipyard_client/shipyard_client/cli/format_utils.py View File

@ -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
# 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 = {
0: ['error', 'fatal'],
1: ['warn', 'warning'],


+ 1
- 1
tools/deckhand_load_yaml.sh View File

@ -66,7 +66,7 @@ create configdocs ${collection} --replace --directory=/target
# Following the creation of a configdocs collection in the Shipyard buffer,
# the configdocs must be committed before Shipyard is able to use them as
# 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
# only mark the revision as committed if the validations are successful
echo -e "Committing Configdocs..."


Loading…
Cancel
Save