Skip to content

Commit

Permalink
Remove Deliverable from the docs.
Browse files Browse the repository at this point in the history
[#130]

Co-authored-by: Emily Johnson <emjohnson@vmware.com>
  • Loading branch information
Rasheed Abdul-Aziz and emmjohnson committed Sep 22, 2021
1 parent f0058b7 commit 71be641
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 59 deletions.
34 changes: 17 additions & 17 deletions site/content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,28 @@ Each pre-approved supply chain creates a paved road to production; orchestrating

## Cartographer Design and Philosophy

Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer allows users to define all of the steps that an application must go through before reaching a production environment. Users can codify their paths to production using two abstractions:
Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer
allows users to define all of the steps that an application must go through to create an image and Kubernetes configuration.
Users achieve this with the Supply Chain abstraction ([Spec Reference](reference.md#clustersupplychain)).

* Supply Chain ([Spec Reference](reference.md/#clustersupplychain))
<!-- * Deliverable ([Spec Reference](reference.md)) -->
The supply chain consists of components that are specified via Templates.
Each template acts as a wrapper for existing Kubernetes resources and allows them to be used with Cartographer.
There are currently four different types of templates that can be use in a Cartographer supply chain:

The supply chain allows users to define the steps that an application must pass through in order to create an image. The deliverable portion of a Cartographer workflow allows the user to define the steps that the built image must pass through. By combining supply chains with delivery, the entire path to production can be specified and thereby choreographed by Cartographer.
* Source Template ([Spec Reference](reference.md#clustersoucetemplate))
* Build Template ([Spec Reference](reference.md#clusterbuildtemplate))
* Opinion Template ([Spec Reference](reference.md#clusteropiniontemplate))
* Cluster Config Template ([Spec Reference](reference.md#clusterconfigtemplate))

The supply chain and delivery are not bound to a single cluster. Cartographer embraces a gitOps approach for image promotion across clusters - a gitOps repo is used to track the Kubernetes configuration that corresponds to a given application. The delivery portion will watch that same gitOps repository and initiate the second half of the path to prod whenever a new configuration is pushed to the repository.
Contrary to many other Kubernetes native workflow tools that already exist in the market,
Cartographer does not “run” any of the objects themselves. Instead, it monitors the execution of
each component and templates the following component in the supply chain after a given component has
completed execution and updated its status.

Both the supply chain and delivery consist of components that are specified via Templates. Each template acts as a wrapper for existing Kubernetes resources and allows them to be used with Cartographer. There are currently four different types of templates that can be use in a Cartographer supply chain or deliverable:
The supply chain may also be extended to include integrations to existing CI and CD pipelines by using the Pipeline Service (which is part of Cartographer Core). The Pipeline Service acts as a wrapper for existing CI and CD tooling (with support for Tekton, and with plans to support more providers in the future) and provides a declarative way for pipelines to be run inside of Cartographer.

* Source Template ([Spec Reference](reference.md/#clustersourcetemplate))
* Image Template ([Spec Reference](reference.md/#clusterimagetemplate))
* Opinion Template ([Spec Reference](reference.md/#clusterconfigtemplate))
* Cluster Config Template ([Spec Reference](reference.md/#clustertemplate))

Contrary to many other Kubernetes native workflow tools that already exist in the market, Cartographer does not “run” any of the objects themselves. Instead, it monitors the execution of each component and templates the following component in the supply chain or delivery after a given component has completed execution and updated its status.

The supply chain and delivery may also be extended to include integrations to existing CI and CD pipelines by using the Pipeline Service (which is part of Cartographer Core). The Pipeline Service acts as a wrapper for existing CI and CD tooling (with support for Tekton and Jenkins, and with supporting more providers in the future) and provides a declarative way for pipelines to be run inside of Cartographer.

While the supply chain and delivery are both operator facing, Cartographer also provides an abstraction for developers called workloads ([Spec Reference](reference.md/#workload)). Workloads allow developers to specify application specifications such as the location of their repository, environment variables and service claims.
While the supply chain is operator facing, Cartographer also provides an abstraction for developers called workloads ([Spec Reference](reference.md#workload)). Workloads allow developers to create application specifications such as the location of their repository, environment variables and service claims.

By design, supply chains can be reused by many workloads. This allows an operator to specify the steps in the path to production a single time, and for developers to specify their applications independently but for each to use the same path to production. The intent is that developers are able to focus on providing value for their users and can reach production quickly and easily, while providing peace of mind for app operators, who are ensured that each application has passed through the steps of the path to production that they’ve defined.

![Cartographer High Level Diagram](img/ownership-flow.png)
![Cartographer High Level Diagram](images/ownership-flow.png)
24 changes: 12 additions & 12 deletions site/content/docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,27 @@ Each pre-approved supply chain creates a paved road to production; orchestrating

## Cartographer Design and Philosophy

Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer allows users to define all of the steps that an application must go through before reaching a production environment. Users can codify their paths to production using two abstractions:
Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer
allows users to define all of the steps that an application must go through to create an image and Kubernetes configuration.
Users achieve this with the Supply Chain abstraction ([Spec Reference](reference.md#clustersupplychain)).

* Supply Chain ([Spec Reference](reference.md#clustersupplychain))
* Deliverable ([Spec Reference](reference.md#deliverable))

The supply chain allows users to define the steps that an application must pass through in order to create an image. The deliverable portion of a Cartographer workflow allows the user to define the steps that the built image must pass through. By combining supply chains with delivery, the entire path to production can be specified and thereby choreographed by Cartographer.

The supply chain and delivery are not bound to a single cluster. Cartographer embraces a gitOps approach for image promotion across clusters - a gitOps repo is used to track the Kubernetes configuration that corresponds to a given application. The delivery portion will watch that same gitOps repository and initiate the second half of the path to prod whenever a new configuration is pushed to the repository.

Both the supply chain and delivery consist of components that are specified via Templates. Each template acts as a wrapper for existing Kubernetes resources and allows them to be used with Cartographer. There are currently four different types of templates that can be use in a Cartographer supply chain or deliverable:
The supply chain consists of components that are specified via Templates.
Each template acts as a wrapper for existing Kubernetes resources and allows them to be used with Cartographer.
There are currently four different types of templates that can be use in a Cartographer supply chain:

* Source Template ([Spec Reference](reference.md#clustersoucetemplate))
* Build Template ([Spec Reference](reference.md#clusterbuildtemplate))
* Opinion Template ([Spec Reference](reference.md#clusteropiniontemplate))
* Cluster Config Template ([Spec Reference](reference.md#clusterconfigtemplate))

Contrary to many other Kubernetes native workflow tools that already exist in the market, Cartographer does not “run” any of the objects themselves. Instead, it monitors the execution of each component and templates the following component in the supply chain or delivery after a given component has completed execution and updated its status.
Contrary to many other Kubernetes native workflow tools that already exist in the market,
Cartographer does not “run” any of the objects themselves. Instead, it monitors the execution of
each component and templates the following component in the supply chain after a given component has
completed execution and updated its status.

The supply chain and delivery may also be extended to include integrations to existing CI and CD pipelines by using the Pipeline Service (which is part of Cartographer Core). The Pipeline Service acts as a wrapper for existing CI and CD tooling (with support for Tekton and Jenkins, and with supporting more providers in the future) and provides a declarative way for pipelines to be run inside of Cartographer.
The supply chain may also be extended to include integrations to existing CI and CD pipelines by using the Pipeline Service (which is part of Cartographer Core). The Pipeline Service acts as a wrapper for existing CI and CD tooling (with support for Tekton, and with plans to support more providers in the future) and provides a declarative way for pipelines to be run inside of Cartographer.

While the supply chain and delivery are both operator facing, Cartographer also provides an abstraction for developers called workloads ([Spec Reference](reference.md#workload)). Workloads allow developers to specify application specifications such as the location of their repository, environment variables and service claims.
While the supply chain is operator facing, Cartographer also provides an abstraction for developers called workloads ([Spec Reference](reference.md#workload)). Workloads allow developers to create application specifications such as the location of their repository, environment variables and service claims.

By design, supply chains can be reused by many workloads. This allows an operator to specify the steps in the path to production a single time, and for developers to specify their applications independently but for each to use the same path to production. The intent is that developers are able to focus on providing value for their users and can reach production quickly and easily, while providing peace of mind for app operators, who are ensured that each application has passed through the steps of the path to production that they’ve defined.

Expand Down
36 changes: 18 additions & 18 deletions site/content/docs/v0.0.6/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
version: v0.0.6
cascade:
layout: docs
layout: docs
---

## TLDR
Expand All @@ -12,28 +12,28 @@ Each pre-approved supply chain creates a paved road to production; orchestrating

## Cartographer Design and Philosophy

Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer allows users to define all of the steps that an application must go through before reaching a production environment. Users can codify their paths to production using two abstractions:
Cartographer is a Kubernetes (K8s) native supply chain choreographer. In other words, Cartographer
allows users to define all of the steps that an application must go through to create an image and Kubernetes configuration.
Users achieve this with the Supply Chain abstraction ([Spec Reference](reference.md#clustersupplychain)).

* Supply Chain ([Spec Reference](reference.md/#clustersupplychain))
<!-- * Deliverable ([Spec Reference](reference.md)) -->
The supply chain consists of components that are specified via Templates.
Each template acts as a wrapper for existing Kubernetes resources and allows them to be used with Cartographer.
There are currently four different types of templates that can be use in a Cartographer supply chain:

The supply chain allows users to define the steps that an application must pass through in order to create an image. The deliverable portion of a Cartographer workflow allows the user to define the steps that the built image must pass through. By combining supply chains with delivery, the entire path to production can be specified and thereby choreographed by Cartographer.
* Source Template ([Spec Reference](reference.md#clustersoucetemplate))
* Build Template ([Spec Reference](reference.md#clusterbuildtemplate))
* Opinion Template ([Spec Reference](reference.md#clusteropiniontemplate))
* Cluster Config Template ([Spec Reference](reference.md#clusterconfigtemplate))

The supply chain and delivery are not bound to a single cluster. Cartographer embraces a gitOps approach for image promotion across clusters - a gitOps repo is used to track the Kubernetes configuration that corresponds to a given application. The delivery portion will watch that same gitOps repository and initiate the second half of the path to prod whenever a new configuration is pushed to the repository.
Contrary to many other Kubernetes native workflow tools that already exist in the market,
Cartographer does not “run” any of the objects themselves. Instead, it monitors the execution of
each component and templates the following component in the supply chain after a given component has
completed execution and updated its status.

Both the supply chain and delivery consist of components that are specified via Templates. Each template acts as a wrapper for existing Kubernetes resources and allows them to be used with Cartographer. There are currently four different types of templates that can be use in a Cartographer supply chain or deliverable:
The supply chain may also be extended to include integrations to existing CI and CD pipelines by using the Pipeline Service (which is part of Cartographer Core). The Pipeline Service acts as a wrapper for existing CI and CD tooling (with support for Tekton, and with plans to support more providers in the future) and provides a declarative way for pipelines to be run inside of Cartographer.

* Source Template ([Spec Reference](reference.md/#clustersourcetemplate))
* Image Template ([Spec Reference](reference.md/#clusterimagetemplate))
* Opinion Template ([Spec Reference](reference.md/#clusterconfigtemplate))
* Cluster Config Template ([Spec Reference](reference.md/#clustertemplate))

Contrary to many other Kubernetes native workflow tools that already exist in the market, Cartographer does not “run” any of the objects themselves. Instead, it monitors the execution of each component and templates the following component in the supply chain or delivery after a given component has completed execution and updated its status.

The supply chain and delivery may also be extended to include integrations to existing CI and CD pipelines by using the Pipeline Service (which is part of Cartographer Core). The Pipeline Service acts as a wrapper for existing CI and CD tooling (with support for Tekton and Jenkins, and with supporting more providers in the future) and provides a declarative way for pipelines to be run inside of Cartographer.

While the supply chain and delivery are both operator facing, Cartographer also provides an abstraction for developers called workloads ([Spec Reference](reference.md/#workload)). Workloads allow developers to specify application specifications such as the location of their repository, environment variables and service claims.
While the supply chain is operator facing, Cartographer also provides an abstraction for developers called workloads ([Spec Reference](reference.md#workload)). Workloads allow developers to create application specifications such as the location of their repository, environment variables and service claims.

By design, supply chains can be reused by many workloads. This allows an operator to specify the steps in the path to production a single time, and for developers to specify their applications independently but for each to use the same path to production. The intent is that developers are able to focus on providing value for their users and can reach production quickly and easily, while providing peace of mind for app operators, who are ensured that each application has passed through the steps of the path to production that they’ve defined.

![Cartographer High Level Diagram](img/ownership-flow.png)
![Cartographer High Level Diagram](images/ownership-flow.png)
Loading

0 comments on commit 71be641

Please sign in to comment.