Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Validated Patterns documentation site

This project contains the new proof-of-concept documentation site for validatedpatterns.io
This project contains the new proof-of-concept documentation site for [validatedpatterns.io](validatedpatterns.io).

You can build this site using [Hugo](https://gohugo.io/).
Use a container image to build the Validated Patterns documentation, locally. See [Preview the documentation using a container image](https://validatedpatterns.io/contribute/contribute-to-docs/#_preview_the_documentation_using_a_container_image).

Alternatively, you can build this site using [Hugo](https://gohugo.io/).

## Install Hugo

Expand Down
1 change: 1 addition & 0 deletions content/contribute/background-on-pattern-development.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ aliases: /background-on-pattern-development/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

== Introduction

Expand Down
2 changes: 2 additions & 0 deletions content/contribute/contribute-to-docs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ weight: 10
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

//Use the Contributor's guide to learn about ways to contribute to the Validated Patterns, to understand the prerequisites and toolchain required for contribution, and to follow some basic documentation style and structure guidelines.

Expand Down
1 change: 1 addition & 0 deletions content/contribute/creating-a-pattern.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ aliases: /creating-a-pattern/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

The validated patterns community has relied on existing architectures that have been successfully deployed in an enterprise. The architecture itself is a best practice in assembling technologies and projects to provide a working solution. How that solution is deployed and managed is a different matter. It may have evolved over time and may have grown in its deployment such that ongoing maintenance is not sustainable.

Expand Down
1 change: 1 addition & 0 deletions content/contribute/extending-a-pattern.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ aliases: /extending-a-pattern/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

== Introduction to extending a pattern using a fork

Expand Down
1 change: 1 addition & 0 deletions content/contribute/structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ aliases: /building-vps/structure/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

== Framework fundamentals

Expand Down
3 changes: 3 additions & 0 deletions content/learn/about.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ weight: 10
---
:toc:

:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

Validated Patterns and upstream Community Patterns are a natural progression from reference architectures with additional value. Here is a brief video to explain what patterns are all about:

image::https://img.youtube.com/vi/lI8TurakeG4/0.jpg[patterns-intro-video,link=https://www.youtube.com/watch?v=lI8TurakeG4]
Expand Down
2 changes: 2 additions & 0 deletions content/learn/importing-a-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases: /learn/importing-a-cluster/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

[id="importing-a-cluster"]
== Importing a managed cluster
Expand Down
2 changes: 2 additions & 0 deletions content/learn/infrastructure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases: /infrastructure/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

[id="background"]
== Background
Expand Down
2 changes: 2 additions & 0 deletions content/learn/ocp-cluster-general-sizing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases: /infrastructure/ocp-cluster-general-sizing/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

= OpenShift General Sizing

Expand Down
2 changes: 2 additions & 0 deletions content/learn/quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ weight: 20
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

== Patterns quick start

Expand Down
2 changes: 2 additions & 0 deletions content/learn/rhel-for-edge-general-sizing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases: /infrastructure/rhel-for-edge-general-sizing/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

= RHEL for Edge General Sizing

Expand Down
2 changes: 2 additions & 0 deletions content/learn/secrets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases: /secrets/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

= Infrastructure

Expand Down
2 changes: 2 additions & 0 deletions content/learn/validated.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases: /requirements/validated/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

= Validated Pattern Requirements

Expand Down
2 changes: 2 additions & 0 deletions content/learn/vault.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases: /secrets/vault/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

= Deploying HashiCorp Vault in a validated pattern

Expand Down
2 changes: 2 additions & 0 deletions content/learn/workflow.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases: /workflow/
---

:toc:
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

= Workflow

Expand Down
1 change: 1 addition & 0 deletions content/patterns/emerging-disease-detection/_index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ contributor:
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

include::modules/edd-about-emerging-disease-detection.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@ aliases: /emerging-disease-detection/getting-started/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

include::modules/edd-deploying-edd-pattern.adoc[leveloffset=1]

include::modules/edd-using-edd-pattern.adoc[leveloffset=1]

= Next Steps

link:https://groups.google.com/g/hybrid-cloud-patterns[Help & Feedback]
link:https://github.com/validatedpatterns/emerging-disease-detection/issues[Report Bugs]
10 changes: 5 additions & 5 deletions content/patterns/hypershift/_index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ industries:
aliases: /hypershift/
pattern_logo: medical-diagnosis.png
links:

help: https://groups.google.com/g/validatedpatterns
bugs: https://github.com/validatedpatterns-sandbox/hypershift/issues
ci: hypershift
Expand All @@ -36,9 +36,9 @@ This pattern simplifies the deployment of an {hcp} or hosted control plane clust
Workflow::

* Install multicluster engine for Kubernetes Operator
* Create an instance of the `MultiClusterEngine` to enable `hypershift`, which is a [technology preview feature](https://access.redhat.com/support/offerings/techpreview).
* Create an instance of the `MultiClusterEngine` to enable `hypershift`, which is a link:https://access.redhat.com/support/offerings/techpreview[technology preview feature].
* Install the AWS Controllers for Kubernetes - Amazon S3 Operator
* Create an S3 bucket that hosted control plane will use for OpenID Connect (OIDC)
* Create an S3 bucket that hosted control plane will use for OpenID Connect (OIDC)
* Create a buildconfig and imagestream that provide the HyperShift cli (`hypershift`) as an imagestream to be used in further automation if desired.

//This pipeline is showcased link:https://www.youtube.com/watch?v=zja83FVsm14[in this video].
Expand All @@ -59,8 +59,8 @@ The {hcp-pattern} uses the following products and technologies:

* {rh-ocp} for container orchestration
* {rh-gitops}, a GitOps continuous delivery (CD) solution
* {rh-mce}, the multicluster-engine provider
* {ack-s3}, a S3 storage controller
* The {rh-mce} Operator, the multicluster-engine provider
* {ack-s3-op}, an S3 storage controller

// All commented out by jrickard
//== Recorded demo
Expand Down
1 change: 1 addition & 0 deletions content/patterns/multicloud-gitops/_index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ ci: mcgitops
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

include::modules/mcg-about-multicloud-gitops.adoc[leveloffset=+1]

Expand Down
1 change: 1 addition & 0 deletions content/patterns/multicloud-gitops/mcg-cluster-sizing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ aliases: /multicloud-gitops/mcg-cluster-sizing/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

include::modules/mcg-about-cluster-sizing.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ aliases: /multicloud-gitops/mcg-getting-started/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

include::modules/mcg-deploying-mcg-pattern.adoc[leveloffset=1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ aliases: /multicloud-gitops/mcg-ideas-for-customization/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

//leaving this here on purpose to test H1 headings in assemblies and it's impact of TOC
= Ideas for customization
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ aliases: /multicloud-gitops/mcg-imperative-actions/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

include::modules/mcg-using-imperative-actions.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ aliases: /multicloud-gitops/mcg-managed-cluster/
:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

//leaving this here on purpose to test H1 headings (with ID) in assemblies and it's impact of TOC
[id="attach-managed-cluster"]
Expand Down
6 changes: 5 additions & 1 deletion modules/mcg-about-cluster-sizing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
[id="about-openshift-cluster-sizing-mcg"]
= About OpenShift cluster sizing for the Multicloud GitOps Pattern

For information on minimum hardware requirements for an OpenShift cluster, refer to the {ocp} documentation for link:https://docs.openshift.com/container-platform/3.11/install/prerequisites.html#hardware[System and environment requirements].
The minimum requirements for an {ocp} cluster depend on your installation platform, for example:

* For AWS, see link:https://docs.openshift.com/container-platform/4.13/installing/installing_aws/preparing-to-install-on-aws.html#requirements-for-installing-ocp-on-aws[Installing {ocp} on AWS].

* For bare-metal, see link:https://docs.openshift.com/container-platform/4.13/installing/installing_bare_metal/installing-bare-metal.html#installation-minimum-resource-requirements_installing-bare-metal[Installing {ocp} on bare metal].

To understand cluster sizing requirements for the Multicloud GitOps pattern, consider the following components that the Multicloud GitOps pattern deploys on the datacenter or the hub OpenShift cluster:

Expand Down