Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
H
helm3
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
go
helm3
Commits
79387903
Commit
79387903
authored
Nov 09, 2015
by
Jack Greenfield
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update design.md
parent
44c264b9
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
10 additions
and
2 deletions
+10
-2
design.md
docs/design/design.md
+10
-2
No files found.
docs/design/design.md
View file @
79387903
...
@@ -67,10 +67,11 @@ Deployment Manager, including:
...
@@ -67,10 +67,11 @@ Deployment Manager, including:
*
Service
*
Service
Deployment Manager processes configurable resources by passing their
Deployment Manager processes configurable resources by passing their
configuration properties directly to kubectl
on the cluster to create, update,
configuration properties directly to kubectl
to create, update, or delete them
or delete the resources
.
in the cluster
.
### Templates
### Templates
Templates are abstract types that can be created using Python or
Templates are abstract types that can be created using Python or
[
Jinja
](
http://jinja.pocoo.org/
)
. A template takes a set of properties as input,
[
Jinja
](
http://jinja.pocoo.org/
)
. A template takes a set of properties as input,
and must output a valid YAML configuration string. Properties are bound to
and must output a valid YAML configuration string. Properties are bound to
...
@@ -159,10 +160,12 @@ Schemas must be imported with the templates they describe, when passing
...
@@ -159,10 +160,12 @@ Schemas must be imported with the templates they describe, when passing
configuration to Deployment Manager.
configuration to Deployment Manager.
### Instantiating Templates
### Instantiating Templates
Templates can be used in two different ways: either passed to the API as an
Templates can be used in two different ways: either passed to the API as an
imported file, or used from a public HTTP endpoint.
imported file, or used from a public HTTP endpoint.
#### Imported Templates
#### Imported Templates
Templates can be imported as part of the target configuration, and used
Templates can be imported as part of the target configuration, and used
directly, for example:
directly, for example:
...
@@ -185,6 +188,7 @@ Using the Deployment Manager API, these templates can be included in the
...
@@ -185,6 +188,7 @@ Using the Deployment Manager API, these templates can be included in the
imports section of the _configuration_.
imports section of the _configuration_.
#### External Templates
#### External Templates
Templates can also be used from a public HTTP endpoint. For example:
Templates can also be used from a public HTTP endpoint. For example:
```
```
...
@@ -206,9 +210,11 @@ When fetching schema files and sub-imports, the base path of the external
...
@@ -206,9 +210,11 @@ When fetching schema files and sub-imports, the base path of the external
template is used for relative paths.
template is used for relative paths.
## API Model
## API Model
Deployment Manager exposes a set of RESTful collections over HTTP/JSON.
Deployment Manager exposes a set of RESTful collections over HTTP/JSON.
### Deployments
### Deployments
Deployments are the primary resource in the Deployment Manager service. The
Deployments are the primary resource in the Deployment Manager service. The
inputs to a deployment are:
inputs to a deployment are:
...
@@ -230,6 +236,7 @@ http://manager-service/deployments
...
@@ -230,6 +236,7 @@ http://manager-service/deployments
```
```
### Manifests
### Manifests
A manifest is created for a deployment every time it is changed. It contains
A manifest is created for a deployment every time it is changed. It contains
three key components:
three key components:
...
@@ -252,6 +259,7 @@ This final set is stored as the _expandedConfig_ and is used during resource
...
@@ -252,6 +259,7 @@ This final set is stored as the _expandedConfig_ and is used during resource
processing.
processing.
#### Layout
#### Layout
Users can use templates to build a rich, deep hierarchical architecture in their
Users can use templates to build a rich, deep hierarchical architecture in their
configuration. Expansion flattens this hierarchy and removes the template
configuration. Expansion flattens this hierarchy and removes the template
relationships from the configuration to create a format optimized for the process
relationships from the configuration to create a format optimized for the process
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment