Add Action API

This change introduces a large section of the API for the next major
version of Shipyard - the action api.  By interfacing with Airflow,
Shipyard will invoke workflows and allow for controlling and querying
status of those workflows. Foundationally, this patchset introduces
a lot of framework code for other apis, including error handling
to a common output format, database interaction for persistence of
action information, and use of oslo_config for configuration support.

Add GET all actions primary code - db connection not yet impl
Update base classes to have more structure
Add POST actions framework
Add GET action by id
Add GET of validations and steps
Add control api
Add unit tests of action api methods
Re-Removed duplicate deps from test reqs
Add routes for API
Removed a lot of code better handled by falcon directly
Cleaned up error flows- handlers and defaults
Refactored existing airflow tests to match standard output format
Updated json validation to be more specific
Added basic start for alembic
Added alembic upgrade at startup
Added table creation definitions
Added base revision for alembic upgrade
Bug fixes - DB queries, airflow comm, logic issues, logging issues
Bug fixes - date formats and alignment of keys between systems
Exclusions to bandit / tox.ini
Resolved merge conflicts with integration of auth
Update to use oslo config and PBR
Update the context middleware to check uuid in a less contentious way
Removed routes and resources for regions endpoint - not used
Add auth policies for action api
Restructure execptions to be consistent class hierarchy and common handler
Add generation of config and policy examples
Update tests to init configs
Update database configs to not use env. vars
Removed examples directory, it was no longer accurate
Addressed/removed several TODOs - left some behind as well
Aligned input to DAGs with action: header
Retrieved all sub-steps for dags
Expanded step information
Refactored auth handling for better logging
rename create_actions policy to create_action
removed some templated file comments in env.py generated by alembic
updated inconsistent exception parameters
updated to use ulid instead of uuid for action ids
added action control audit code per review suggestion
Fixed correlation date betwen dags/actions by more string parsing

Change-Id: I2f9ea5250923f45456aa86826e344fc055bba762

.gitignore

@@ -99,3 +99,6 @@ ENV/
 
 # mypy
 .mypy_cache/
+
+# Generated bogus docs
+ChangeLog

AUTHORS

@@ -0,0 +1,13 @@
+Alan Meadows <alan.meadows@gmail.com>
+Anthony Lin <anthony.jclin@gmail.com>
+Bryan Strassner <bryan.strassner@gmail.com>
+Felipe Monteiro <felipe.monteiro@att.com>
+Mark Burnett <mark.m.burnett@gmail.com>
+One-Fine-Day <vd789v@att.com>
+Pete Birley <pete@port.direct>
+Rodolfo <rp2723@att.com>
+Scott Hussey <sh8121@att.com>
+Stacey Fletcher <staceylynnfletcher@gmail.com>
+Tin Lam <tin@irrational.io>
+Vamsi Krishna Surapureddi <vamsi.skrishna@gmail.com>
+eanylin <anthony.jclin@gmail.com>

Dockerfile

@@ -60,9 +60,6 @@ COPY ./ /home/shipyard/shipyard
 # Copy entrypoint.sh to /home/shipyard
 COPY entrypoint.sh /home/shipyard/entrypoint.sh
 
-# Copy shipyard.conf to /home/shipyard
-COPY ./shipyard_airflow/control/shipyard.conf /home/shipyard/shipyard.conf
-
 # Change permissions
 RUN chown -R shipyard: /home/shipyard \
     && chmod +x /home/shipyard/entrypoint.sh

alembic.ini

@@ -0,0 +1,69 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# max length of characters to apply to the
+# "slug" field
+#truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat alembic/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+#Uses the envrionment variable instead: DB_CONN_SHIPYARD
+sqlalchemy.url = NOT_APPLICABLE
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

alembic/env.py

@@ -0,0 +1,81 @@
+from __future__ import with_statement
+
+import os
+from logging.config import fileConfig
+
+from alembic import context
+from oslo_config import cfg
+from sqlalchemy import create_engine, pool
+
+# this is the shipyard config object
+CONF = cfg.CONF
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.attributes.get('configure_logger', True):
+    fileConfig(config.config_file_name)
+
+target_metadata = None
+
+
+def get_url():
+    """
+    Returns the url to use instead of using the alembic configuration
+    file
+    """
+    return CONF.base.postgresql_db
+
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = get_url()
+    # Default code: url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url, target_metadata=target_metadata, literal_binds=True)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    connectable = create_engine(get_url())
+    # Default/generated code:
+    #  connectable = engine_from_config(
+    #     config.get_section(config.config_ini_section),
+    #     prefix='sqlalchemy.',
+    #     poolclass=pool.NullPool)
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

alembic/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

alembic/versions/51b92375e5c4_initial_shipyard_base.py

@@ -0,0 +1,82 @@
+"""initial shipyard  base
+
+Revision ID: 51b92375e5c4
+Revises:
+Create Date: 2017-09-12 11:12:23.768269
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy import (types, func)
+from sqlalchemy.dialects import postgresql as pg
+
+
+# revision identifiers, used by Alembic.
+revision = '51b92375e5c4'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    """
+    Create the initial tables needed by shipyard
+    26 character IDs are ULIDs. See: https://github.com/mdipierro/ulid
+    """
+    op.create_table(
+        'actions',
+        # ULID key for the action
+        sa.Column('id', types.String(26), primary_key=True),
+        # The name of the action invoked
+        sa.Column('name', types.String(50), nullable=False),
+        # The parameters passed by the user to the action
+        sa.Column('parameters', pg.JSONB, nullable=True),
+        # The DAG/workflow name used in airflow, if applicable
+        sa.Column('dag_id', sa.Text, nullable=True),
+        # The DAG/workflow execution time string from airflow, if applicable
+        sa.Column('dag_execution_date', sa.Text, nullable=True),
+        # The invoking user
+        sa.Column('user', sa.Text, nullable=False),
+        # Timestamp of when an action was invoked
+        sa.Column('datetime',
+                  types.TIMESTAMP(timezone=True),
+                  server_default=func.now()),
+        # The user provided or shipayrd generated context marker
+        sa.Column('context_marker', types.String(36), nullable=False)
+    )
+
+    op.create_table(
+        'preflight_validation_failures',
+        # ID (ULID) of the preflight validation failure
+        sa.Column('id', types.String(26), primary_key=True),
+        # The ID of action this failure is associated with
+        sa.Column('action_id', types.String(26), nullable=False),
+        # The common language name of the validation that failed
+        sa.Column('validation_name', sa.Text, nullable=True),
+        # The text indicating details of the failure
+        sa.Column('details', sa.Text, nullable=True),
+    )
+
+    op.create_table(
+        'action_command_audit',
+        # ID (ULID) of the audit
+        sa.Column('id', types.String(26), primary_key=True),
+        # The ID of action this audit record
+        sa.Column('action_id', types.String(26), nullable=False),
+        # The text indicating command invoked
+        sa.Column('command', sa.Text, nullable=False),
+        # The user that invoked the command
+        sa.Column('user', sa.Text, nullable=False),
+        # Timestamp of when the command was invoked
+        sa.Column('datetime',
+                  types.TIMESTAMP(timezone=True),
+                  server_default=func.now()),
+    )
+
+def downgrade():
+    """
+    Remove the database objects created by this revision
+    """
+    op.drop_table('actions')
+    op.drop_table('preflight_validation_failures')
+    op.drop_table('action_command_audit')

docs/API.md

@@ -276,7 +276,7 @@ Returns the details for a step by id for the given action by Id.
 * 200 OK
 
 ---
-### /v1.0/actions/{action_id}/{control_verb}
+### /v1.0/actions/{action_id}/control/{control_verb}
 Allows for issuing DAG controls against an action.
 
 #### Payload Structure

entrypoint.sh

@@ -14,7 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 # Start shipyard application
-exec uwsgi --http :9000 -w shipyard_airflow.shipyard --callable shipyard --enable-threads -L
-
+exec uwsgi \
+    --http :9000 \
+    --paste config:/etc/shipyard/api-paste.ini \
+    --enable-threads \
+    -L \
+    --pyargv "--config-file /etc/shipyard/shipyard.conf"

etc/shipyard/policy.yaml.sample

@@ -0,0 +1,27 @@
+# Actions requiring admin authority
+#"admin_required": "role:admin"
+
+# List workflow actions invoked by users
+# GET  /api/v1.0/actions
+#"workflow_orchestrator:list_actions": "rule:admin_required"
+
+# Create a workflow action
+# POST  /api/v1.0/actions
+#"workflow_orchestrator:create_actions": "rule:admin_required"
+
+# Retreive an action by its id
+# GET  /api/v1.0/actions/{action_id}
+#"workflow_orchestrator:get_action": "rule:admin_required"
+
+# Retreive an action step by its id
+# GET  /api/v1.0/actions/{action_id}/steps/{step_id}
+#"workflow_orchestrator:get_action_step": "rule:admin_required"
+
+# Retreive an action validation by its id
+# GET  /api/v1.0/actions/{action_id}/validations/{validation_id}
+#"workflow_orchestrator:get_action_validation": "rule:admin_required"
+
+# Send a control to an action
+# POST  /api/v1.0/actions/{action_id}/control/{control_verb}
+#"workflow_orchestrator:invoke_action_control": "rule:admin_required"
+

etc/shipyard/shipyard.conf.sample

@@ -0,0 +1,310 @@
+[DEFAULT]
+
+
+[armada]
+
+#
+# From shipyard_airflow
+#
+
+# FQDN for the armada service (string value)
+#host = armada-int.ucp
+
+# Port for the armada service (integer value)
+#port = 8000
+
+
+[base]
+
+#
+# From shipyard_airflow
+#
+
+# The web server for Airflow (string value)
+#web_server = http://localhost:32080
+
+# The database for shipyard (string value)
+#postgresql_db = postgresql+psycopg2://shipyard:changeme@postgresql.ucp:5432/shipyard
+
+# The database for airflow (string value)
+#postgresql_airflow_db = postgresql+psycopg2://shipyard:changeme@postgresql.ucp:5432/airflow
+
+# The direcotry containing the alembic.ini file (string value)
+#alembic_ini_path = /home/shipyard/shipyard
+
+# Upgrade the database on startup (boolean value)
+#upgrade_db = true
+
+
+[deckhand]
+
+#
+# From shipyard_airflow
+#
+
+# FQDN for the deckhand service (string value)
+#host = deckhand-int.ucp
+
+# Port for the deckhand service (integer value)
+#port = 80
+
+
+[drydock]
+
+#
+# From shipyard_airflow
+#
+
+# FQDN for the drydock service (string value)
+#host = drydock-int.ucp
+
+# Port for the drydock service (integer value)
+#port = 9000
+
+# TEMPORARY: password for drydock (string value)
+#token = bigboss
+
+# TEMPORARY: location of drydock yaml file (string value)
+#site_yaml = /usr/local/airflow/plugins/drydock.yaml
+
+# TEMPORARY: location of promenade yaml file (string value)
+#prom_yaml = /usr/local/airflow/plugins/promenade.yaml
+
+
+[healthcheck]
+
+#
+# From shipyard_airflow
+#
+
+# Schema to perform health check with (string value)
+#schema = http
+
+# Health check standard endpoint (string value)
+#endpoint = /api/v1.0/health
+
+
+[keystone]
+
+#
+# From shipyard_airflow
+#
+
+# The url for OpenStack Authentication (string value)
+#OS_AUTH_URL = http://keystone-api.ucp:80/v3
+
+# OpenStack project name (string value)
+#OS_PROJECT_NAME = service
+
+# The OpenStack user domain name (string value)
+#OS_USER_DOMAIN_NAME = Default
+
+# The OpenStack username (string value)
+#OS_USERNAME = shipyard
+
+# THe OpenStack password for the shipyard svc acct (string value)
+#OS_PASSWORD = password
+
+# The OpenStack user domain name (string value)
+#OS_REGION_NAME = Regionone
+
+# The OpenStack identity api version (integer value)
+#OS_IDENTITY_API_VERSION = 3
+
+
+[keystone_authtoken]
+
+#
+# From keystonemiddleware.auth_token
+#
+
+# Complete "public" Identity API endpoint. This endpoint should not be an
+# "admin" endpoint, as it should be accessible by all end users.
+# Unauthenticated clients are redirected to this endpoint to authenticate.
+# Although this endpoint should ideally be unversioned, client support in the
+# wild varies. If you're using a versioned v2 endpoint here, then this should
+# *not* be the same endpoint the service user utilizes for validating tokens,
+# because normal end users may not be able to reach that endpoint. (string
+# value)
+#auth_uri = <None>
+
+# API version of the admin Identity API endpoint. (string value)
+#auth_version = <None>
+
+# Do not handle authorization requests within the middleware, but delegate the
+# authorization decision to downstream WSGI components. (boolean value)
+#delay_auth_decision = false
+
+# Request timeout value for communicating with Identity API server. (integer
+# value)
+#http_connect_timeout = <None>
+
+# How many times are we trying to reconnect when communicating with Identity
+# API Server. (integer value)
+#http_request_max_retries = 3
+
+# Request environment key where the Swift cache object is stored. When
+# auth_token middleware is deployed with a Swift cache, use this option to have
+# the middleware share a caching backend with swift. Otherwise, use the
+# ``memcached_servers`` option instead. (string value)
+#cache = <None>
+
+# Required if identity server requires client certificate (string value)
+#certfile = <None>
+
+# Required if identity server requires client certificate (string value)
+#keyfile = <None>
+
+# A PEM encoded Certificate Authority to use when verifying HTTPs connections.
+# Defaults to system CAs. (string value)
+#cafile = <None>
+
+# Verify HTTPS connections. (boolean value)
+#insecure = false
+
+# The region in which the identity server can be found. (string value)
+#region_name = <None>
+
+# DEPRECATED: Directory used to cache files related to PKI tokens. This option
+# has been deprecated in the Ocata release and will be removed in the P
+# release. (string value)
+# This option is deprecated for removal since Ocata.
+# Its value may be silently ignored in the future.
+# Reason: PKI token format is no longer supported.
+#signing_dir = <None>
+
+# Optionally specify a list of memcached server(s) to use for caching. If left
+# undefined, tokens will instead be cached in-process. (list value)
+# Deprecated group/name - [keystone_authtoken]/memcache_servers
+#memcached_servers = <None>
+
+# In order to prevent excessive effort spent validating tokens, the middleware
+# caches previously-seen tokens for a configurable duration (in seconds). Set
+# to -1 to disable caching completely. (integer value)
+#token_cache_time = 300
+
+# DEPRECATED: Determines the frequency at which the list of revoked tokens is
+# retrieved from the Identity service (in seconds). A high number of revocation
+# events combined with a low cache duration may significantly reduce
+# performance. Only valid for PKI tokens. This option has been deprecated in
+# the Ocata release and will be removed in the P release. (integer value)
+# This option is deprecated for removal since Ocata.
+# Its value may be silently ignored in the future.
+# Reason: PKI token format is no longer supported.
+#revocation_cache_time = 10
+
+# (Optional) If defined, indicate whether token data should be authenticated or
+# authenticated and encrypted. If MAC, token data is authenticated (with HMAC)
+# in the cache. If ENCRYPT, token data is encrypted and authenticated in the
+# cache. If the value is not one of these options or empty, auth_token will
+# raise an exception on initialization. (string value)
+# Allowed values: None, MAC, ENCRYPT
+#memcache_security_strategy = None
+
+# (Optional, mandatory if memcache_security_strategy is defined) This string is
+# used for key derivation. (string value)
+#memcache_secret_key = <None>
+
+# (Optional) Number of seconds memcached server is considered dead before it is
+# tried again. (integer value)
+#memcache_pool_dead_retry = 300
+
+# (Optional) Maximum total number of open connections to every memcached
+# server. (integer value)
+#memcache_pool_maxsize = 10
+
+# (Optional) Socket timeout in seconds for communicating with a memcached
+# server. (integer value)
+#memcache_pool_socket_timeout = 3
+
+# (Optional) Number of seconds a connection to memcached is held unused in the
+# pool before it is closed. (integer value)
+#memcache_pool_unused_timeout = 60
+
+# (Optional) Number of seconds that an operation will wait to get a memcached
+# client connection from the pool. (integer value)
+#memcache_pool_conn_get_timeout = 10
+
+# (Optional) Use the advanced (eventlet safe) memcached client pool. The
+# advanced pool will only work under python 2.x. (boolean value)
+#memcache_use_advanced_pool = false
+
+# (Optional) Indicate whether to set the X-Service-Catalog header. If False,
+# middleware will not ask for service catalog on token validation and will not
+# set the X-Service-Catalog header. (boolean value)
+#include_service_catalog = true
+
+# Used to control the use and type of token binding. Can be set to: "disabled"
+# to not check token binding. "permissive" (default) to validate binding
+# information if the bind type is of a form known to the server and ignore it
+# if not. "strict" like "permissive" but if the bind type is unknown the token
+# will be rejected. "required" any form of token binding is needed to be
+# allowed. Finally the name of a binding method that must be present in tokens.
+# (string value)
+#enforce_token_bind = permissive
+
+# DEPRECATED: If true, the revocation list will be checked for cached tokens.
+# This requires that PKI tokens are configured on the identity server. (boolean
+# value)
+# This option is deprecated for removal since Ocata.
+# Its value may be silently ignored in the future.
+# Reason: PKI token format is no longer supported.
+#check_revocations_for_cached = false
+
+# DEPRECATED: Hash algorithms to use for hashing PKI tokens. This may be a
+# single algorithm or multiple. The algorithms are those supported by Python
+# standard hashlib.new(). The hashes will be tried in the order given, so put
+# the preferred one first for performance. The result of the first hash will be
+# stored in the cache. This will typically be set to multiple values only while
+# migrating from a less secure algorithm to a more secure one. Once all the old
+# tokens are expired this option should be set to a single value for better
+# performance. (list value)
+# This option is deprecated for removal since Ocata.
+# Its value may be silently ignored in the future.
+# Reason: PKI token format is no longer supported.
+#hash_algorithms = md5
+
+# A choice of roles that must be present in a service token. Service tokens are
+# allowed to request that an expired token can be used and so this check should
+# tightly control that only actual services should be sending this token. Roles
+# here are applied as an ANY check so any role in this list must be present.
+# For backwards compatibility reasons this currently only affects the
+# allow_expired check. (list value)
+#service_token_roles = service
+
+# For backwards compatibility reasons we must let valid service tokens pass
+# that don't pass the service_token_roles check as valid. Setting this true
+# will become the default in a future release and should be enabled if
+# possible. (boolean value)
+#service_token_roles_required = false
+
+# Authentication type to load (string value)
+# Deprecated group/name - [keystone_authtoken]/auth_plugin
+#auth_type = <None>
+
+# Config Section from which to load plugin specific options (string value)
+#auth_section = <None>
+
+
+[logging]
+
+#
+# From shipyard_airflow
+#
+
+# The default logging level for the root logger. ERROR=40, WARNING=30, INFO=20,
+# DEBUG=10 (integer value)
+#log_level = 10
+
+
+[shipyard]
+
+#
+# From shipyard_airflow
+#
+
+# FQDN for the shipyard service (string value)
+#host = shipyard-int.ucp
+
+# Port for the shipyard service (integer value)
+#port = 9000

examples/manifests/README.md

@@ -1,60 +0,0 @@
-# Shipyard Manifests
-
-----
-
-Shipyard manifests contain the examination of the payloads that the shipyard api will receive.
-A complete manifest will consist of multiple yaml file's assembled in some way. Each yaml file will follow
-Kubernetes style artifact definition.
-
-The high level expectation of what the data on this manifests will define is pictured here :
-
-<img src="https://github.com/att-comdev/shipyard/examples/manifests/manifest_hierarchy.png" width="100">
-
-----
-
-## region_manifest.yaml
-
-Region is the largest resource shipyard can understand.
-A region manifest will need to define :
-
-- Identity of the Region. Perhaps a name will suffice, but a UUID generated by shipyard might be applicable as well.
-- Cloud : The type of cloud this region is running on. i.e. AIC, or AWS, or Google etc.
-- deployOn : Whether the region UCP ( undercloud) is been deployed on VM's or Baremetal
-
-----
-## servers.yaml
-
-----
-## network.yaml
-
-----
-## hw_definition.yaml
-
-----
-## host_profile.yaml
-
-----
-## services.yaml
-
-Will define high level needs for all the services that need to run above the undercloud
-
-It relates to the files :
-
-## core_services.yaml
-## clcp_services.yaml
-## onap_services.yaml
-## cdp_services.yaml
-
-
-----
-## undercloud.yaml
-
-This file will incude the configuration aspects of the undercloud that are tunnables.
-Such as :
-i.e.
--Security 
--RBAC definitions
--Certificates
--UCP Tunnables
--Kernel Tunnables, etc
--Agent Tunnables

examples/manifests/hostprofile.yaml

@@ -1,151 +0,0 @@
-# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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.
-####################
-#
-# bootstrap_seed.yaml - Site server design definition for physical layer
-#
-####################
-# version the schema in this file so consumers can rationally parse it  
-
----
-apiVersion: 'v1.0'
-kind: HostProfile
-metadata:
-  name: default
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-  # No magic to this host_profile, it just provides a way to specify
-  # sitewide settings. If it is absent from a node's inheritance chain
-  # then these values will NOT be applied
-spec:
-  # OOB (iLO, iDRAC, etc...) settings. Should prefer open standards such
-  # as IPMI over vender-specific when possible.
-  oob:
-    type: ipmi
-    # OOB networking should be preconfigured, but we can include a network
-    # definition for validation or enhancement (DNS registration)
-    network: oob
-    account: admin
-    credential: admin
-  # Specify storage layout of base OS. Ceph out of scope
-  storage:
-    # How storage should be carved up: lvm (logical volumes), flat 
-    # (single partition)
-    layout: lvm
-    # Info specific to the boot and root disk/partitions
-    bootdisk:
-      # Device will specify an alias defined in hwdefinition.yaml
-      device: primary_boot
-      # For LVM, the size of the partition added to VG as a PV
-      # For flat, the size of the partition formatted as ext4
-      root_size: 50g
-      # The /boot partition. If not specified, /boot will in root
-      boot_size: 2g
-    # Info for additional partitions. Need to balance between
-    # flexibility and complexity
-    partitions:
-    - name: logs
-      device: primary_boot
-      # Partition uuid if needed
-      part_uuid: 84db9664-f45e-11e6-823d-080027ef795a
-      size: 10g
-      # Optional, can carve up unformatted block devices
-      mountpoint: /var/log
-      fstype: ext4
-      mount_options: defaults
-      # Filesystem UUID or label can be specified. UUID recommended
-      fs_uuid: cdb74f1c-9e50-4e51-be1d-068b0e9ff69e
-      fs_label: logs
-  # Platform (Operating System) settings
-  platform:
-    image: ubuntu_16.04_hwe
-    kernel_params: default
-  # Additional metadata to apply to a node
-  metadata:
-    # Base URL of the introspection service - may go in curtin data
-    introspection_url: http://172.16.1.10:9090
----
-apiVersion: 'v1.0'
-kind: HostProfile
-metadata:
-  name: k8-node
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  # host_profile inheritance allows for deduplication of common CIs
-  # Inheritance is additive for CIs that are lists of multiple items
-  # To remove an inherited list member, prefix the primary key value
-  # with '!'. 
-  host_profile: defaults
-  # Hardware profile will map hardware specific details to the abstract
-  # names uses in the host profile as well as specify hardware specific
-  # configs. A viable model should be to build a host profile without a
-  # hardware_profile and then for each node inherit the host profile and
-  # specify a hardware_profile to map that node's hardware to the abstract
-  # settings of the host_profile
-  hardware_profile: HPGen9v3
-  # Network interfaces.
-  interfaces:
-  # Keyed on device_name
-  # pxe is a special marker indicating which device should be used for pxe boot
-  - device_name: pxe
-    # The network link attached to this 
-    network_link: pxe
-    # Slaves will specify aliases from hwdefinition.yaml
-    slaves:
-    - prim_nic01
-    # Which networks will be configured on this interface
-    networks: 
-    - name: pxe
-  - device_name: bond0
-    network_link: gp
-    # If multiple slaves are specified, but no bonding config
-    # is applied to the link, design validation will fail
-    slaves:
-    - prim_nic01
-    - prim_nic02
-    # If multiple networks are specified, but no trunking
-    # config is applied to the link, design validation will fail
-    networks:
-    - name: mgmt
-    - name: private
-  metadata:
-    # Explicit tag assignment
-    tags:
-    - 'test'
-    # MaaS supports key/value pairs. Not sure of the use yet
-    owner_data:
-      foo: bar
----
-apiVersion: 'v1.0'
-kind: HostProfile
-metadata:
-  name: k8-node-public
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  host_profile: k8-node
-  interfaces:
-    - device_name: bond0
-      networks:
-        # This is additive, so adds a network to those defined in the host_profile
-        # inheritance chain
-      - name: public
----

examples/manifests/hwdefinition.yaml

@@ -1,58 +0,0 @@
-# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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.
-#############################################################################
-#
-# bootstrap_hwdefinition.yaml - Definitions of server hardware layout
-#
-#############################################################################
-# version the schema in this file so consumers can rationally parse it
----
-apiVersion: 'v1.0'
-kind: HardwareProfile
-metadata:
-  name: HPGen8v3
-  region: sitename
-  date: 17-FEB-2017
-  description: Sample hardware definition
-  author: Scott Hussey
-spec:
-  # Vendor of the server chassis
-  vendor: HP
-  # Generation of the chassis model
-  generation: '8'
-  # Version of the chassis model within its generation - not version of the hardware definition
-  hw_version: '3'
-  # The certified version of the chassis BIOS
-  bios_version: '2.2.3'
-  # Mode of the default boot of hardware - bios, uefi
-  boot_mode: bios
-  # Protocol of boot of the hardware - pxe, usb, hdd
-  bootstrap_protocol: pxe
-  # Which interface to use for network booting within the OOB manager, not OS device
-  pxe_interface: 0
-  # Map hardware addresses to aliases/roles to allow a mix of hardware configs
-  # in a site to result in a consistent configuration
-  device_aliases:
-    pci:
-    - address: pci@0000:00:03.0
-      alias: prim_nic01
-      # type could identify expected hardware - used for hardware manifest validation
-      type: '82540EM Gigabit Ethernet Controller'
-    - address: pci@0000:00:04.0
-      alias: prim_nic02
-      type: '82540EM Gigabit Ethernet Controller'
-    scsi:
-    - address: scsi@2:0.0.0
-      alias: primary_boot
-      type: 'VBOX HARDDISK'

examples/manifests/network.yml

@@ -1,230 +0,0 @@
-# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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.
-####################
-#
-# network.yaml - Network infor,ation  design definition for physical layer
-#
-####################
-# version the schema in this file so consumers can rationally parse it  
-
----
----
-apiVersion: 'v1.0'
-kind: NetworkLink
-metadata:
-  name: oob
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 1 attributes. Primary key is 'name'. These settings will generally be things the switch and server have to agree on
-spec:
-  bonding:
-    mode: none
-  mtu: 1500
-  linkspeed: 100full
-  trunking:
-    mode: none
-    default_network: oob
----
-# pxe is a bit of 'magic' indicating the link config used when PXE booting
-# a node. All other links indicate network configs applied when the node
-# is deployed.
-apiVersion: 'v1.0'
-kind: NetworkLink
-metadata:
-  name: pxe
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 1 attributes. Primary key is 'name'. These settings will generally be things the switch and server have to agree on
-spec:
-  bonding:
-    mode: none
-  mtu: 1500
-  linkspeed: auto
-  # Is this link supporting multiple layer 2 networks?
-  # none is a port-based VLAN identified by default_network
-  # tagged is is using 802.1q VLAN tagging. Untagged packets will default to default_netwokr
-  trunking:
-    mode: none
-    # use name, will translate to VLAN ID
-    default_network: pxe
----
-apiVersion: 'v1.0'
-kind: NetworkLink
-metadata:
-  name: gp
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 1 attributes. These CIs will generally be things the switch and server have to agree on
-  # pxe is a bit of 'magic' indicating the link config used when PXE booting
-  # a node. All other links indicate network configs applied when the node
-  # is deployed.
-spec:
-  # If this link is a bond of physical links, how is it configured
-  # 802.3ad
-  # active-backup
-  # balance-rr 
-  # Can add support for others down the road
-  bonding:
-    mode: 802.3ad
-    # For LACP (802.3ad) xmit hashing policy: layer2, layer2+3, layer3+4, encap3+4
-    hash: layer3+4
-    # 802.3ad specific options
-    peer_rate: slow
-    mon_rate: default
-    up_delay: default
-    down_delay: default
-  mtu: 9000
-  linkspeed: auto
-  # Is this link supporting multiple layer 2 networks?
-  trunking:
-    mode: tagged
-    default_network: mgmt
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: oob
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  allocation: static
-  cidr: 172.16.100.0/24
-  ranges:
-    - type: static
-       start: 172.16.100.15
-       end: 172.16.100.254
-    dns:
-      domain: ilo.sitename.att.com
-      servers: 172.16.100.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: pxe
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces  
-spec:
-    # Layer 2 VLAN segment id, could support other segmentations. Optional
-  vlan_id: '99'
-    # How are addresses assigned?
-  allocation: dhcp
-    # MTU for this VLAN interface, if not specified it will be inherited from the link
-  mtu: 1500
-    # Network address
-  cidr: 172.16.0.0/24
-    # Desribe IP address ranges
-  ranges: 
-  - type: dhcp
-    start: 172.16.0.5
-    end: 172.16.0.254
-    # DNS settings for this network
-  dns:
-      # Domain addresses on this network will be registered under
-    domain: admin.sitename.att.com
-      # DNS servers that a server using this network as its default gateway should use
-    servers: 172.16.0.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: mgmt
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  vlan_id: '100'
-    # How are addresses assigned?
-  allocation: static
-    # Allow MTU to be inherited from link the network rides on
-  mtu: 1500
-    # Network address
-  cidr: 172.16.1.0/24
-    # Desribe IP address ranges
-  ranges: 
-  - type: static
-    start: 172.16.1.15
-    end: 172.16.1.254
-    # Static routes to be added for this network
-  routes:
-  - subnet: 0.0.0.0/0
-        # A blank gateway would leave to a static route specifying
-        # only the interface as a source
-    gateway: 172.16.1.1
-    metric: 10
-    # DNS settings for this network
-  dns:
-      # Domain addresses on this network will be registered under
-    domain: mgmt.sitename.example.com
-      # DNS servers that a server using this network as its default gateway should use
-    servers: 172.16.1.9,172.16.1.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: private
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  vlan_id: '101'
-  allocation: static
-  mtu: 9000
-  cidr: 172.16.2.0/24
-    # Desribe IP address ranges
-  ranges: 
-      # Type can be reserved (not used for baremetal), static (all explicit
-      # assignments should fall here), dhcp (will be used by a DHCP server on this network)
-  - type: static
-    start: 172.16.2.15
-    end: 172.16.2.254
-  dns:
-    domain: priv.sitename.example.com
-    servers: 172.16.2.9,172.16.2.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: public
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  vlan_id: '102'
-    # How are addresses assigned?
-  allocation: static
-    # MTU size for the VLAN interface
-  mtu: 1500
-  cidr: 172.16.3.0/24
-    # Desribe IP address ranges
-  ranges: 
-  - type: static
-    start: 172.16.3.15
-    end: 172.16.3.254
-  routes:
-  - subnet: 0.0.0.0/0
-    gateway: 172.16.3.1
-    metric: 9
-  dns:
-    domain: sitename.example.com
-    servers: 8.8.8.8

examples/manifests/region_manifest.yml

@@ -1,60 +0,0 @@
-# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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.
-####################
-#
-# region_manifest.yaml - Region Manifest File , encapsulates the multiple files
-#
-####################
-# version
-
----
-#
-# This describes the Global details of a Region
-#
-apiVersion: 'v1.0'
-kind: Region
-metadata:
-  name: sitename
-  date: 17-FEB-2017
-  description: Sample site design
-  author: sh8121@att.com
-spec:
-
-
--------
-imports:
-    # Servers will include the list of Servers
-    # For Each Server it includes 
-    # information such as :
-    #     # OOB (iLO, iDRAC, etc...) settings. Should prefer open standards such
-    # as IPMI over vender-specific when possible.
-    # oob:
-    #  type: ipmi
-    # OOB networking should be preconfigured, but we can include a network
-    # definition for validation or enhancement (DNS registration)
-    # Specify storage layout of base OS. Ceph out of scope
-    # storage:
-    # How storage should be carved up: lvm (logical volumes), flat 
-    # (single partition)
-    # Platform (Operating System) settings
-    # platform:
-    # Additional metadata to apply to a node
-    @ metadata:
-    - 'servers.yaml'
-    
-    - 'network.yaml'
-    - 'hwdefinition.yaml'
-    - 'hostprofile.yaml'
-    
-    

examples/manifests/servers.yaml

@@ -1,420 +0,0 @@
-# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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.
-####################
-#
-# bootstrap_seed.yaml - Site server design definition for physical layer
-#
-####################
-# version the schema in this file so consumers can rationally parse it
----
-apiVersion: 'v1.0'
-kind: Region
-metadata:
-  name: sitename
-  date: 17-FEB-2017
-  description: Sample site design
-  author: sh8121@att.com
-spec:
-  # Not sure if we have site wide data that doesn't fall into another 'Kind'
----
-apiVersion: 'v1.0'
-kind: NetworkLink
-metadata:
-  name: oob
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 1 attributes. Primary key is 'name'. These settings will generally be things the switch and server have to agree on
-spec:
-  bonding:
-    mode: none
-  mtu: 1500
-  linkspeed: 100full
-  trunking:
-    mode: none
-    default_network: oob
----
-# pxe is a bit of 'magic' indicating the link config used when PXE booting
-# a node. All other links indicate network configs applied when the node
-# is deployed.
-apiVersion: 'v1.0'
-kind: NetworkLink
-metadata:
-  name: pxe
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 1 attributes. Primary key is 'name'. These settings will generally be things the switch and server have to agree on
-spec:
-  bonding:
-    mode: none
-  mtu: 1500
-  linkspeed: auto
-  # Is this link supporting multiple layer 2 networks?
-  # none is a port-based VLAN identified by default_network
-  # tagged is is using 802.1q VLAN tagging. Untagged packets will default to default_netwokr
-  trunking:
-    mode: none
-    # use name, will translate to VLAN ID
-    default_network: pxe
----
-apiVersion: 'v1.0'
-kind: NetworkLink
-metadata:
-  name: gp
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 1 attributes. These CIs will generally be things the switch and server have to agree on
-  # pxe is a bit of 'magic' indicating the link config used when PXE booting
-  # a node. All other links indicate network configs applied when the node
-  # is deployed.
-spec:
-  # If this link is a bond of physical links, how is it configured
-  # 802.3ad
-  # active-backup
-  # balance-rr 
-  # Can add support for others down the road
-  bonding:
-    mode: 802.3ad
-    # For LACP (802.3ad) xmit hashing policy: layer2, layer2+3, layer3+4, encap3+4
-    hash: layer3+4
-    # 802.3ad specific options
-    peer_rate: slow
-    mon_rate: default
-    up_delay: default
-    down_delay: default
-  mtu: 9000
-  linkspeed: auto
-  # Is this link supporting multiple layer 2 networks?
-  trunking:
-    mode: tagged
-    default_network: mgmt
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: oob
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  allocation: static
-  cidr: 172.16.100.0/24
-  ranges:
-    - type: static
-       start: 172.16.100.15
-       end: 172.16.100.254
-    dns:
-      domain: ilo.sitename.att.com
-      servers: 172.16.100.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: pxe
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces  
-spec:
-    # Layer 2 VLAN segment id, could support other segmentations. Optional
-  vlan_id: '99'
-    # How are addresses assigned?
-  allocation: dhcp
-    # MTU for this VLAN interface, if not specified it will be inherited from the link
-  mtu: 1500
-    # Network address
-  cidr: 172.16.0.0/24
-    # Desribe IP address ranges
-  ranges: 
-  - type: dhcp
-    start: 172.16.0.5
-    end: 172.16.0.254
-    # DNS settings for this network
-  dns:
-      # Domain addresses on this network will be registered under
-    domain: admin.sitename.att.com
-      # DNS servers that a server using this network as its default gateway should use
-    servers: 172.16.0.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: mgmt
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  vlan_id: '100'
-    # How are addresses assigned?
-  allocation: static
-    # Allow MTU to be inherited from link the network rides on
-  mtu: 1500
-    # Network address
-  cidr: 172.16.1.0/24
-    # Desribe IP address ranges
-  ranges: 
-  - type: static
-    start: 172.16.1.15
-    end: 172.16.1.254
-    # Static routes to be added for this network
-  routes:
-  - subnet: 0.0.0.0/0
-        # A blank gateway would leave to a static route specifying
-        # only the interface as a source
-    gateway: 172.16.1.1
-    metric: 10
-    # DNS settings for this network
-  dns:
-      # Domain addresses on this network will be registered under
-    domain: mgmt.sitename.example.com
-      # DNS servers that a server using this network as its default gateway should use
-    servers: 172.16.1.9,172.16.1.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: private
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  vlan_id: '101'
-  allocation: static
-  mtu: 9000
-  cidr: 172.16.2.0/24
-    # Desribe IP address ranges
-  ranges: 
-      # Type can be reserved (not used for baremetal), static (all explicit
-      # assignments should fall here), dhcp (will be used by a DHCP server on this network)
-  - type: static
-    start: 172.16.2.15
-    end: 172.16.2.254
-  dns:
-    domain: priv.sitename.example.com
-    servers: 172.16.2.9,172.16.2.10
----
-apiVersion: 'v1.0'
-kind: Network
-metadata:
-  name: public
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  vlan_id: '102'
-    # How are addresses assigned?
-  allocation: static
-    # MTU size for the VLAN interface
-  mtu: 1500
-  cidr: 172.16.3.0/24
-    # Desribe IP address ranges
-  ranges: 
-  - type: static
-    start: 172.16.3.15
-    end: 172.16.3.254
-  routes:
-  - subnet: 0.0.0.0/0
-    gateway: 172.16.3.1
-    metric: 9
-  dns:
-    domain: sitename.example.com
-    servers: 8.8.8.8
----
-apiVersion: 'v1.0'
-kind: HostProfile
-metadata:
-  name: default
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-  # No magic to this host_profile, it just provides a way to specify
-  # sitewide settings. If it is absent from a node's inheritance chain
-  # then these values will NOT be applied
-spec:
-  # OOB (iLO, iDRAC, etc...) settings. Should prefer open standards such
-  # as IPMI over vender-specific when possible.
-  oob:
-    type: ipmi
-    # OOB networking should be preconfigured, but we can include a network
-    # definition for validation or enhancement (DNS registration)
-    network: oob
-    account: admin
-    credential: admin
-  # Specify storage layout of base OS. Ceph out of scope
-  storage:
-    # How storage should be carved up: lvm (logical volumes), flat 
-    # (single partition)
-    layout: lvm
-    # Info specific to the boot and root disk/partitions
-    bootdisk:
-      # Device will specify an alias defined in hwdefinition.yaml
-      device: primary_boot
-      # For LVM, the size of the partition added to VG as a PV
-      # For flat, the size of the partition formatted as ext4
-      root_size: 50g
-      # The /boot partition. If not specified, /boot will in root
-      boot_size: 2g
-    # Info for additional partitions. Need to balance between
-    # flexibility and complexity
-    partitions:
-    - name: logs
-      device: primary_boot
-      # Partition uuid if needed
-      part_uuid: 84db9664-f45e-11e6-823d-080027ef795a
-      size: 10g
-      # Optional, can carve up unformatted block devices
-      mountpoint: /var/log
-      fstype: ext4
-      mount_options: defaults
-      # Filesystem UUID or label can be specified. UUID recommended
-      fs_uuid: cdb74f1c-9e50-4e51-be1d-068b0e9ff69e
-      fs_label: logs
-  # Platform (Operating System) settings
-  platform:
-    image: ubuntu_16.04_hwe
-    kernel_params: default
-  # Additional metadata to apply to a node
-  metadata:
-    # Base URL of the introspection service - may go in curtin data
-    introspection_url: http://172.16.1.10:9090
----
-apiVersion: 'v1.0'
-kind: HostProfile
-metadata:
-  name: k8-node
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  # host_profile inheritance allows for deduplication of common CIs
-  # Inheritance is additive for CIs that are lists of multiple items
-  # To remove an inherited list member, prefix the primary key value
-  # with '!'. 
-  host_profile: defaults
-  # Hardware profile will map hardware specific details to the abstract
-  # names uses in the host profile as well as specify hardware specific
-  # configs. A viable model should be to build a host profile without a
-  # hardware_profile and then for each node inherit the host profile and
-  # specify a hardware_profile to map that node's hardware to the abstract
-  # settings of the host_profile
-  hardware_profile: HPGen9v3
-  # Network interfaces.
-  interfaces:
-  # Keyed on device_name
-  # pxe is a special marker indicating which device should be used for pxe boot
-  - device_name: pxe
-    # The network link attached to this 
-    network_link: pxe
-    # Slaves will specify aliases from hwdefinition.yaml
-    slaves:
-    - prim_nic01
-    # Which networks will be configured on this interface
-    networks: 
-    - name: pxe
-  - device_name: bond0
-    network_link: gp
-    # If multiple slaves are specified, but no bonding config
-    # is applied to the link, design validation will fail
-    slaves:
-    - prim_nic01
-    - prim_nic02
-    # If multiple networks are specified, but no trunking
-    # config is applied to the link, design validation will fail
-    networks:
-    - name: mgmt
-    - name: private
-  metadata:
-    # Explicit tag assignment
-    tags:
-    - 'test'
-    # MaaS supports key/value pairs. Not sure of the use yet
-    owner_data:
-      foo: bar
----
-apiVersion: 'v1.0'
-kind: HostProfile
-metadata:
-  name: k8-node-public
-  region: sitename
-  date: 17-FEB-2017
-  author: sh8121@att.com
-  description: Describe layer 2/3 attributes. Primarily CIs used for configuring server interfaces
-spec:
-  host_profile: k8-node
-  interfaces:
-    - device_name: bond0
-      networks:
-        # This is additive, so adds a network to those defined in the host_profile
-        # inheritance chain
-      - name: public
----
-apiVersion: 'v1.0'