-
Notifications
You must be signed in to change notification settings - Fork 584
infra: Add more constants for platforms and update godoc #182
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
Merged
openshift-merge-robot
merged 1 commit into
openshift:master
from
smarterclayton:more_constants
Jan 29, 2019
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -7,7 +7,6 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
|
|
||
| // Infrastructure holds cluster-wide information about Infrastructure. The canonical name is `cluster` | ||
| // TODO this object is an example of a possible grouping and is subject to change or removal | ||
| type Infrastructure struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| // Standard object's metadata. | ||
|
|
@@ -19,39 +18,54 @@ type Infrastructure struct { | |
| Status InfrastructureStatus `json:"status"` | ||
| } | ||
|
|
||
| // InfrastructureSpec contains settings that apply to the cluster infrastructure. | ||
| type InfrastructureSpec struct { | ||
| // secret reference? | ||
| // configmap reference to file? | ||
| } | ||
|
|
||
| // InfrastructureStatus describes the infrastructure the cluster is leveraging. | ||
| type InfrastructureStatus struct { | ||
| // platform is the underlying infrastructure provider for the cluster. This | ||
| // value controls whether infrastructure automation such as service load | ||
| // balancers, dynamic volume provisioning, machine creation and deletion, and | ||
| // other integrations are enabled. If None, no infrastructure automation is | ||
| // enabled. | ||
| // enabled. Allowed values are "AWS", "Azure", "GCP", "Libvirt", | ||
| // "OpenStack", "VSphere", and "None". Individual components may not support | ||
| // all platforms, and must handle unrecognized platforms as None if they do | ||
| // not support that platform. | ||
| Platform PlatformType `json:"platform,omitempty"` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| } | ||
|
|
||
| // platformType is a specific supported infrastructure provider. | ||
| // PlatformType is a specific supported infrastructure provider. | ||
| type PlatformType string | ||
|
|
||
| const ( | ||
| // awsPlatform represents Amazon AWS. | ||
| // AWSPlatform represents Amazon Web Services infrastructure. | ||
| AWSPlatform PlatformType = "AWS" | ||
|
|
||
| // openStackPlatform represents OpenStack. | ||
| OpenStackPlatform PlatformType = "OpenStack" | ||
| // AzurePlatform represents Microsoft Azure infrastructure. | ||
| AzurePlatform PlatformType = "Azure" | ||
|
|
||
| // GCPPlatform represents Google Cloud Platform infrastructure. | ||
| GCPPlatform PlatformType = "GCP" | ||
|
|
||
| // libvirtPlatform represents libvirt. | ||
| // LibvirtPlatform represents libvirt infrastructure. | ||
| LibvirtPlatform PlatformType = "Libvirt" | ||
|
|
||
| // nonePlatform means there is no infrastructure provider. | ||
| // OpenStackPlatform represents OpenStack infrastructure. | ||
| OpenStackPlatform PlatformType = "OpenStack" | ||
|
|
||
| // NonePlatform means there is no infrastructure provider. | ||
| NonePlatform PlatformType = "None" | ||
|
|
||
| // VSpherePlatform represents VMWare vSphere infrastructure. | ||
| VSpherePlatform PlatformType = "VSphere" | ||
| ) | ||
|
|
||
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
|
|
||
| // InfrastructureList is | ||
| type InfrastructureList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| // Standard object's metadata. | ||
|
|
||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need advice for components to indicate their lack of support.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do, but that'll be in #1112. I don't want our public api docs to be instructions to our teams (beyond general statements), especially since we don't know the instructions quite yet.