-
Notifications
You must be signed in to change notification settings - Fork 110
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cc11303
commit ccfc83a
Showing
65 changed files
with
40,572 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
title: "Overview" | ||
weight: -1 | ||
cascade: | ||
version: "1.17" | ||
--- | ||
|
||
{{< 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**. | ||
|
||
Crossplane lets you manage anything, anywhere, all through standard Kubernetes | ||
APIs. Crossplane can even let you | ||
[order a pizza](https://blog.crossplane.io/providers-101-ordering-pizza-with-kubernetes-and-crossplane/) | ||
directly from Kubernetes. If it has an API, Crossplane can connect to it. | ||
|
||
With Crossplane, platform teams can create new abstractions and custom | ||
APIs with the full power of Kubernetes policies, namespaces, role based access | ||
controls and more. Crossplane brings all your non-Kubernetes resources under | ||
one roof. | ||
|
||
Custom APIs, created by platform teams, allow security and compliance | ||
enforcement across resources or clouds, without exposing any complexity to the | ||
developers. A single API call can create multiple resources, in multiple clouds | ||
and use Kubernetes as the control plane for everything. | ||
|
||
{{< hint "tip" >}} | ||
**What's a control plane?** | ||
<!-- vale Google.WordList = NO --> | ||
Control planes create and manage the lifecycle of resources. Control planes | ||
constantly _check_ that the intended resources exist, _report_ when the intended | ||
state doesn't match reality and _act_ to make things right. | ||
|
||
Crossplane extends the Kubernetes control plane to be a **universal control | ||
plane** to check, report and act on any resource, anywhere. | ||
<!-- vale Google.WordList = YES --> | ||
{{< /hint >}} | ||
|
||
|
||
# Get started | ||
* [Install Crossplane]({{<ref "software/install">}}) in your Kubernetes cluster | ||
* Learn more about how Crossplane works in the | ||
[Crossplane introduction]({{<ref "getting-started/introduction" >}}) | ||
* Join the [Crossplane Slack](https://slack.crossplane.io/) and start a | ||
conversation with a community of over 7,000 operators. | ||
|
||
|
||
Crossplane is a [Cloud Native Compute Foundation](https://www.cncf.io/) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: API Reference | ||
weight: 400 | ||
description: "API details for Crossplane's core types" | ||
cascade: | ||
product: crds | ||
--- | ||
|
||
The Crossplane API describes the types and parameters for the core Crossplane | ||
components. | ||
|
||
For details on the components read the [Concepts]({{<ref "../concepts/">}}) | ||
section. |
581 changes: 581 additions & 0 deletions
581
content/v1.17/api/crds/apiextensions.crossplane.io_compositeresourcedefinitions.yaml
Large diffs are not rendered by default.
Oops, something went wrong.
3,314 changes: 3,314 additions & 0 deletions
3,314
content/v1.17/api/crds/apiextensions.crossplane.io_compositionrevisions.yaml
Large diffs are not rendered by default.
Oops, something went wrong.
1,601 changes: 1,601 additions & 0 deletions
1,601
content/v1.17/api/crds/apiextensions.crossplane.io_compositions.yaml
Large diffs are not rendered by default.
Oops, something went wrong.
63 changes: 63 additions & 0 deletions
63
content/v1.17/api/crds/apiextensions.crossplane.io_environmentconfigs.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
apiVersion: apiextensions.k8s.io/v1 | ||
kind: CustomResourceDefinition | ||
metadata: | ||
annotations: | ||
controller-gen.kubebuilder.io/version: v0.14.0 | ||
name: environmentconfigs.apiextensions.crossplane.io | ||
spec: | ||
group: apiextensions.crossplane.io | ||
names: | ||
categories: | ||
- crossplane | ||
kind: EnvironmentConfig | ||
listKind: EnvironmentConfigList | ||
plural: environmentconfigs | ||
shortNames: | ||
- envcfg | ||
singular: environmentconfig | ||
scope: Cluster | ||
versions: | ||
- additionalPrinterColumns: | ||
- jsonPath: .metadata.creationTimestamp | ||
name: AGE | ||
type: date | ||
name: v1alpha1 | ||
schema: | ||
openAPIV3Schema: | ||
description: |- | ||
An EnvironmentConfig contains user-defined unstructured values for | ||
use in a Composition. | ||
Read the Crossplane documentation for | ||
[more information about EnvironmentConfigs](https://docs.crossplane.io/latest/concepts/environment-configs). | ||
properties: | ||
apiVersion: | ||
description: |- | ||
APIVersion defines the versioned schema of this representation of an object. | ||
Servers should convert recognized schemas to the latest internal value, and | ||
may reject unrecognized values. | ||
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
type: string | ||
data: | ||
additionalProperties: | ||
x-kubernetes-preserve-unknown-fields: true | ||
description: |- | ||
The data of this EnvironmentConfig. | ||
This may contain any kind of structure that can be serialized into JSON. | ||
type: object | ||
kind: | ||
description: |- | ||
Kind is a string value representing the REST resource this object represents. | ||
Servers may infer this from the endpoint the client submits requests to. | ||
Cannot be updated. | ||
In CamelCase. | ||
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
type: string | ||
metadata: | ||
type: object | ||
type: object | ||
served: true | ||
storage: true | ||
subresources: {} |
217 changes: 217 additions & 0 deletions
217
content/v1.17/api/crds/apiextensions.crossplane.io_usages.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,217 @@ | ||
--- | ||
apiVersion: apiextensions.k8s.io/v1 | ||
kind: CustomResourceDefinition | ||
metadata: | ||
annotations: | ||
controller-gen.kubebuilder.io/version: v0.14.0 | ||
name: usages.apiextensions.crossplane.io | ||
spec: | ||
group: apiextensions.crossplane.io | ||
names: | ||
categories: | ||
- crossplane | ||
kind: Usage | ||
listKind: UsageList | ||
plural: usages | ||
singular: usage | ||
scope: Cluster | ||
versions: | ||
- additionalPrinterColumns: | ||
- jsonPath: .metadata.annotations.crossplane\.io/usage-details | ||
name: DETAILS | ||
type: string | ||
- jsonPath: .status.conditions[?(@.type=='Ready')].status | ||
name: READY | ||
type: string | ||
- jsonPath: .metadata.creationTimestamp | ||
name: AGE | ||
type: date | ||
name: v1alpha1 | ||
schema: | ||
openAPIV3Schema: | ||
description: |- | ||
A Usage defines a deletion blocking relationship between two resources. | ||
Usages prevent accidental deletion of a single resource or deletion of | ||
resources with dependent resources. | ||
Read the Crossplane documentation for | ||
[more information about Compositions](https://docs.crossplane.io/latest/concepts/usages). | ||
properties: | ||
apiVersion: | ||
description: |- | ||
APIVersion defines the versioned schema of this representation of an object. | ||
Servers should convert recognized schemas to the latest internal value, and | ||
may reject unrecognized values. | ||
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
type: string | ||
kind: | ||
description: |- | ||
Kind is a string value representing the REST resource this object represents. | ||
Servers may infer this from the endpoint the client submits requests to. | ||
Cannot be updated. | ||
In CamelCase. | ||
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
type: string | ||
metadata: | ||
type: object | ||
spec: | ||
description: UsageSpec defines the desired state of Usage. | ||
properties: | ||
by: | ||
description: By is the resource that is "using the other resource". | ||
properties: | ||
apiVersion: | ||
description: API version of the referent. | ||
type: string | ||
kind: | ||
description: |- | ||
Kind of the referent. | ||
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
type: string | ||
resourceRef: | ||
description: Reference to the resource. | ||
properties: | ||
name: | ||
description: Name of the referent. | ||
type: string | ||
required: | ||
- name | ||
type: object | ||
resourceSelector: | ||
description: |- | ||
Selector to the resource. | ||
This field will be ignored if ResourceRef is set. | ||
properties: | ||
matchControllerRef: | ||
description: |- | ||
MatchControllerRef ensures an object with the same controller reference | ||
as the selecting object is selected. | ||
type: boolean | ||
matchLabels: | ||
additionalProperties: | ||
type: string | ||
description: MatchLabels ensures an object with matching labels | ||
is selected. | ||
type: object | ||
type: object | ||
type: object | ||
x-kubernetes-validations: | ||
- message: either a resource reference or a resource selector should | ||
be set. | ||
rule: has(self.resourceRef) || has(self.resourceSelector) | ||
of: | ||
description: Of is the resource that is "being used". | ||
properties: | ||
apiVersion: | ||
description: API version of the referent. | ||
type: string | ||
kind: | ||
description: |- | ||
Kind of the referent. | ||
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
type: string | ||
resourceRef: | ||
description: Reference to the resource. | ||
properties: | ||
name: | ||
description: Name of the referent. | ||
type: string | ||
required: | ||
- name | ||
type: object | ||
resourceSelector: | ||
description: |- | ||
Selector to the resource. | ||
This field will be ignored if ResourceRef is set. | ||
properties: | ||
matchControllerRef: | ||
description: |- | ||
MatchControllerRef ensures an object with the same controller reference | ||
as the selecting object is selected. | ||
type: boolean | ||
matchLabels: | ||
additionalProperties: | ||
type: string | ||
description: MatchLabels ensures an object with matching labels | ||
is selected. | ||
type: object | ||
type: object | ||
type: object | ||
x-kubernetes-validations: | ||
- message: either a resource reference or a resource selector should | ||
be set. | ||
rule: has(self.resourceRef) || has(self.resourceSelector) | ||
reason: | ||
description: Reason is the reason for blocking deletion of the resource. | ||
type: string | ||
replayDeletion: | ||
description: ReplayDeletion will trigger a deletion on the used resource | ||
during the deletion of the usage itself, if it was attempted to | ||
be deleted at least once. | ||
type: boolean | ||
required: | ||
- of | ||
type: object | ||
x-kubernetes-validations: | ||
- message: either "spec.by" or "spec.reason" must be specified. | ||
rule: has(self.by) || has(self.reason) | ||
status: | ||
description: UsageStatus defines the observed state of Usage. | ||
properties: | ||
conditions: | ||
description: Conditions of the resource. | ||
items: | ||
description: A Condition that may apply to a resource. | ||
properties: | ||
lastTransitionTime: | ||
description: |- | ||
LastTransitionTime is the last time this condition transitioned from one | ||
status to another. | ||
format: date-time | ||
type: string | ||
message: | ||
description: |- | ||
A Message containing details about this condition's last transition from | ||
one status to another, if any. | ||
type: string | ||
observedGeneration: | ||
description: |- | ||
ObservedGeneration represents the .metadata.generation that the condition was set based upon. | ||
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date | ||
with respect to the current state of the instance. | ||
format: int64 | ||
type: integer | ||
reason: | ||
description: A Reason for this condition's last transition from | ||
one status to another. | ||
type: string | ||
status: | ||
description: Status of this condition; is it currently True, | ||
False, or Unknown? | ||
type: string | ||
type: | ||
description: |- | ||
Type of this condition. At most one of each condition type may apply to | ||
a resource at any point in time. | ||
type: string | ||
required: | ||
- lastTransitionTime | ||
- reason | ||
- status | ||
- type | ||
type: object | ||
type: array | ||
x-kubernetes-list-map-keys: | ||
- type | ||
x-kubernetes-list-type: map | ||
type: object | ||
required: | ||
- spec | ||
type: object | ||
served: true | ||
storage: true | ||
subresources: | ||
status: {} |
Oops, something went wrong.