Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nav proof of concept - DO NOT MERGE #585

Closed
wants to merge 3 commits into from
Closed
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
11 changes: 11 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Crossplane Documentation"
weight: 13
---

{{< img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}}

<br />

Crossplane is an open source Kubernetes extension that transforms your Kubernetes
cluster into a **universal control plane**.
13 changes: 13 additions & 0 deletions content/cli/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
weight: 40
title: Crossplane CLI
description: "Documentation for the Crossplane command-line interface"
---

The Crossplane CLI helps simplify some development and administration aspects of
Crossplane.

The Crossplane CLI includes:
* tools to build, install, update and push Crossplane Packages
* standalone Composition Function testing and rendering without the need to access a Kubernetes cluster running Crossplane
* visual dependency mapping across Compositions, Composite Resources and Managed Resources
8 changes: 8 additions & 0 deletions content/cli/command-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
weight: 50
title: Command Reference
description: "Command reference for the Crossplane CLI"
---

<!-- vale Google.Headings = NO -->
The `crossplane` CLI provides utilities to make using Crossplane easier.
3 changes: 1 addition & 2 deletions content/contribute/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: "Contributing Guide"
weight: -1
weight: 100
cascade:
version: "0"
docs: false
product: "Contributing Guide"
---
Expand Down
2 changes: 0 additions & 2 deletions content/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,6 @@ Crossplane documentation has three content sections:
how to contribute to the Crossplane documentation.
* The [Knowledge Base]({{<ref "/knowledge-base" >}}) is for content related to
Crossplane integrations, in-depth articles or how-to guides.
* [User documentation]({{<ref "/master" >}}) are for generic documentation,
commonly version-specific.

#### User documentation vs knowledge base articles
User documentation includes both _conceptual_ and _procedural_ instructions.
Expand Down
7 changes: 0 additions & 7 deletions content/contribute/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,13 +173,6 @@ Crossplane recommends using the [Hugo ref shortcode](https://gohugo.io/content-m
with the path of the file relative to `/content` for the link location.

For example, to link to the `master` release index page use
<!-- vale off -->
```markdown
[master branch documentation]({{</* ref "master/_index.md" */>}})
```
<!-- vale on -->

<!-- [master branch documentation]({{<ref "master/_index.md" >}}) -->

The `ref` value is of the markdown file, including `.md` extension.

Expand Down
9 changes: 9 additions & 0 deletions content/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Get Started
weight: 1
description: An introduction to Crossplane and Crossplane quickstart guides.
---

{{<img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}}

## Hands-On
8 changes: 8 additions & 0 deletions content/getting-started/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Crossplane Introduction
weight: 2
---

Crossplane connects your Kubernetes cluster to external,
non-Kubernetes resources, and allows platform teams to build custom Kubernetes
APIs to consume those resources.
9 changes: 9 additions & 0 deletions content/getting-started/provider-aws-part-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: AWS Quickstart Part 2
weight: 120
tocHidden: true
aliases:
- /v1.13/getting-started/provider-aws-part-3
---
* an AWS account with permissions to create an AWS S3 storage bucket and a
DynamoDB instance
7 changes: 7 additions & 0 deletions content/getting-started/provider-aws.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: AWS Quickstart
weight: 100
---

Connect Crossplane to AWS to create and manage cloud resources from Kubernetes
with the
10 changes: 10 additions & 0 deletions content/getting-started/provider-azure-part-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure Quickstart Part 2
weight: 120
tocHidden: true
aliases:
- /v1.13/getting-started/provider-azure-part-3
---

* an AWS account with permissions to create an AWS S3 storage bucket and a
DynamoDB instance
8 changes: 8 additions & 0 deletions content/getting-started/provider-azure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Azure Quickstart
weight: 110
---

Connect Crossplane to Azure to create and manage cloud resources from Kubernetes
with the
[Upbound Azure Provider](https://marketplace.upbound.io/providers/upbound/provider-family-azure/).
10 changes: 10 additions & 0 deletions content/getting-started/provider-gcp-part-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: GCP Quickstart Part 2
weight: 120
tocHidden: true
aliases:
- /v1.13/getting-started/provider-azure-part-3
---

* an AWS account with permissions to create an AWS S3 storage bucket and a
DynamoDB instance
8 changes: 8 additions & 0 deletions content/getting-started/provider-gcp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: GCP Quickstart
weight: 140
---

Connect Crossplane to GCP to create and manage cloud resources from Kubernetes
with the
[Upbound GCP Provider](https://marketplace.upbound.io/providers/upbound/provider-family-gcp/).
3 changes: 1 addition & 2 deletions content/knowledge-base/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Knowledge Base
weight: -1
weight: 50
cascade:
version: "0"
docs: false
product: "Knowledge Base"
---
Expand Down
4 changes: 2 additions & 2 deletions content/knowledge-base/guides/composition-revisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ spec:
name: db-conn
```

[composition-type]: {{<ref "../../master/concepts/compositions" >}}
[Compositions]: {{<ref "../../master/concepts/compositions" >}}
[composition-type]: {{<ref "../../v1.13/concepts/compositions" >}}
[Compositions]: {{<ref "../../v1.13/concepts/compositions" >}}
[canary]: https://martinfowler.com/bliki/CanaryRelease.html
[install-guide]: {{<ref "../../master/software/install" >}}
24 changes: 12 additions & 12 deletions content/knowledge-base/guides/connection-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ description: "How to create and manage connection details across Crossplane mana
---

Using connection details in Crossplane requires the following components:
* Defining the `writeConnectionSecretToRef.name` in a [Claim]({{<ref "/master/concepts/claims#claim-connection-secrets">}}).
* Defining the `writeConnectionSecretsToNamespace` value in the [Composition]({{<ref "/master/concepts/compositions#composite-resource-combined-secret">}}).
* Defining the `writeConnectionSecretToRef.name` in a [Claim]({{<ref "/v1.13/concepts/claims#claim-connection-secrets">}}).
* Defining the `writeConnectionSecretsToNamespace` value in the [Composition]({{<ref "/v1.13/concepts/compositions#composite-resource-combined-secret">}}).
* Define the `writeConnectionSecretToRef` name and namespace for each resource in the
[Composition]({{<ref "/master/concepts/compositions#composed-resource-secrets">}}).
[Composition]({{<ref "/v1.13/concepts/compositions#composed-resource-secrets">}}).
* Define the list of secret keys produced by each composed resource with `connectionDetails` in the
[Composition]({{<ref "/master/concepts/compositions#define-secret-keys">}}).
[Composition]({{<ref "/v1.13/concepts/compositions#define-secret-keys">}}).
* Optionally, define the `connectionSecretKeys` in a
[CompositeResourceDefinition]({{<ref "/master/concepts/composite-resource-definitions#manage-connection-secrets">}}).
[CompositeResourceDefinition]({{<ref "/v1.13/concepts/composite-resource-definitions#manage-connection-secrets">}}).

{{<hint "note">}}
This guide discusses creating Kubernetes secrets.
Expand All @@ -23,7 +23,7 @@ with an external secret store.
{{</hint >}}

## Background
When a [Provider]({{<ref "/master/concepts/providers">}}) creates a managed
When a [Provider]({{<ref "/v1.13/concepts/providers">}}) creates a managed
resource, the resource may generate resource-specific details. These details can include
usernames, passwords or connection details like an IP address.

Expand All @@ -37,10 +37,10 @@ detail_ from a managed resource.
<!-- vale gitlab.SentenceLength = NO -->
<!-- wordy because of type names -->
When a managed resource is part of a
[Composition]({{<ref "/master/concepts/compositions">}}), the Composition,
[Composite Resource Definition]({{<ref "/master/concepts/composite-resource-definitions">}})
[Composition]({{<ref "/v1.13/concepts/compositions">}}), the Composition,
[Composite Resource Definition]({{<ref "/v1.13/concepts/composite-resource-definitions">}})
and optionally, the
[Claim]({{<ref "/master/concepts/claims">}}) define what details are visible
[Claim]({{<ref "/v1.13/concepts/claims">}}) define what details are visible
and where they're stored.
<!-- vale gitlab.SentenceLength = YES -->

Expand Down Expand Up @@ -191,17 +191,17 @@ spec:
<!-- under 25 words -->
When a managed resource creates connection secrets, Crossplane can write the
secrets to a
[Kubernetes secret]({{<ref "/master/concepts/managed-resources#publish-secrets-to-kubernetes">}})
[Kubernetes secret]({{<ref "/v1.13/concepts/managed-resources#publish-secrets-to-kubernetes">}})
or an
[external secret store]({{<ref "/master/concepts/managed-resources#publish-secrets-to-an-external-secrets-store">}}).
[external secret store]({{<ref "/v1.13/concepts/managed-resources#publish-secrets-to-an-external-secrets-store">}}).
<!-- vale gitlab.SentenceLength = YES -->
<!-- vale gitlab.Substitutions = YES -->

Creating an individual managed resource shows the connection secrets the
resource creates.

{{<hint "note" >}}
Read the [managed resources]({{<ref "/master/concepts/managed-resources">}})
Read the [managed resources]({{<ref "/v1.13/concepts/managed-resources">}})
documentation for more information on configuring resources and storing
connection secrets for individual resources.
{{< /hint >}}
Expand Down
4 changes: 2 additions & 2 deletions content/knowledge-base/guides/multi-tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ dedicated control planes to many tenants within a single organization.


<!-- Named Links -->
[managed resources]: {{<ref "../../master/concepts/managed-resources" >}}
[managed resources]: {{<ref "../../v1.13/concepts/managed-resources" >}}
[RBAC]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
[Composition]: {{<ref "../../v1.12/concepts/composition" >}}
[CustomResourceDefinitions]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
Expand All @@ -311,7 +311,7 @@ dedicated control planes to many tenants within a single organization.
[Gatekeeper]: https://open-policy-agent.github.io/gatekeeper/website/docs/
[here]: https://youtu.be/TaF0_syejXc
[Multiple Source Field patching]: https://github.com/crossplane/crossplane/pull/2093
[Configuration packages]: {{<ref "../../master/concepts/packages" >}}
[Configuration packages]: {{<ref "../../v1.13/concepts/packages" >}}
[OCI images]: https://github.com/opencontainers/image-spec
[EKS Cluster]: https://marketplace.upbound.io/providers/crossplane-contrib/provider-aws/latest/resources/eks.aws.crossplane.io/Cluster/v1beta1
[provider-aws]: https://marketplace.upbound.io/providers/crossplane-contrib/provider-aws
Expand Down
2 changes: 1 addition & 1 deletion content/knowledge-base/guides/self-signed-ca-certs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ registries, it must be configured to trust the CA and Intermediate certs.

Crossplane needs to be installed via the Helm chart with the
`registryCaBundleConfig.name` and `registryCaBundleConfig.key` parameters
defined. See [Install Crossplane]({{<ref "../../master/software/install" >}}).


## Configure

Expand Down
4 changes: 2 additions & 2 deletions content/knowledge-base/guides/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Debugging Composite Resource Definition (XRD) is like debugging Compositions.
You can use install providers in two ways: `configuration.pkg.crossplane.io` and `provider.pkg.crossplane.io`. You can use either one to install providers with no functional differences to providers themselves.
If you define a `configuration.pkg.crossplane.io` object, Crossplane creates a
`provider.pkg.crossplane.io` object and manages it. Refer to [the Packages
documentation]({{<ref "/master/concepts/packages">}})
documentation]({{<ref "/v1.13/concepts/packages">}})
for more information about Crossplane Packages.

If you are experiencing provider issues, steps below are a good starting point.
Expand Down Expand Up @@ -518,7 +518,7 @@ To follow the references:
[Pausing Providers]: #pausing-providers
[Deleting When a Resource Hangs]: #deleting-when-a-resource-hangs
[Installing Crossplane Package]: #installing-crossplane-package
[Crossplane package]: /master/concepts/packages/
[Crossplane package]: /v1.13/concepts/packages/
[Handling Crossplane Package Dependency]: #handling-crossplane-package-dependency
[semver spec]: https://github.com/Masterminds/semver#basic-comparisons

Expand Down
3 changes: 2 additions & 1 deletion content/master/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Overview"
weight: -1
weight: 10
cascade:
version: "master"
draft: true
---

{{< img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}}
Expand Down
4 changes: 2 additions & 2 deletions content/v1.11/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Overview"
weight: -1
title: "Crossplane v1.11"
weight: 12
cascade:
version: "1.11"
---
Expand Down
4 changes: 2 additions & 2 deletions content/v1.12/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Overview"
weight: -1
title: "Crossplane v1.12"
weight: 11
cascade:
version: "1.12"
---
Expand Down
4 changes: 2 additions & 2 deletions content/v1.13/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Overview"
weight: -1
title: "Crossplane v1.13"
weight: 10
cascade:
version: "1.13"
---
Expand Down
16 changes: 0 additions & 16 deletions content/v1.13/getting-started/_index.md

This file was deleted.

Loading
Loading