Documentation
¶
Overview ¶
Package restapi AssistedInstall
Assisted installation Schemes: http https Host: api.openshift.com BasePath: /api/assisted-install/v1 Version: 1.0.0 Consumes: - application/json - multipart/form-data Produces: - application/octet-stream - application/json
swagger:meta
Index ¶
Constants ¶
View Source
const AuthKey contextKey = "Auth"
Variables ¶
View Source
var ( // SwaggerJSON embedded version of the swagger document used at generation time SwaggerJSON json.RawMessage // FlatSwaggerJSON embedded flattened version of the swagger document used at generation time FlatSwaggerJSON json.RawMessage )
Functions ¶
func Handler ¶
Handler returns an http.Handler given the handler configuration It mounts all the business logic implementers in the right routing.
func HandlerAPI ¶
func HandlerAPI(c Config) (http.Handler, *operations.AssistedInstallAPI, error)
HandlerAPI returns an http.Handler given the handler configuration and the corresponding *AssistedInstall instance. It mounts all the business logic implementers in the right routing.
Types ¶
type Config ¶
type Config struct {
EventsAPI
InstallerAPI
ManagedDomainsAPI
VersionsAPI
Logger func(string, ...interface{})
// InnerMiddleware is for the handler executors. These do not apply to the swagger.json document.
// The middleware executes after routing but before authentication, binding and validation
InnerMiddleware func(http.Handler) http.Handler
// Authorizer is used to authorize a request after the Auth function was called using the "Auth*" functions
// and the principal was stored in the context in the "AuthKey" context value.
Authorizer func(*http.Request) error
// AuthAgentAuth Applies when the "X-Secret-Key" header is set
AuthAgentAuth func(token string) (interface{}, error)
// AuthUserAuth Applies when the "Authorization" header is set
AuthUserAuth func(token string) (interface{}, error)
// Authenticator to use for all APIKey authentication
APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
// Authenticator to use for all Bearer authentication
BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
// Authenticator to use for all Basic authentication
BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator
}
Config is configuration for Handler
type EventsAPI ¶
type EventsAPI interface {
/* ListEvents Lists events for a cluster */
ListEvents(ctx context.Context, params events.ListEventsParams) middleware.Responder
}
EventsAPI
type InstallerAPI ¶
type InstallerAPI interface {
/* CancelInstallation Cancels an ongoing installation. */
CancelInstallation(ctx context.Context, params installer.CancelInstallationParams) middleware.Responder
/* CompleteInstallation Agent API to mark a finalizing installation as complete. */
CompleteInstallation(ctx context.Context, params installer.CompleteInstallationParams) middleware.Responder
/* DeregisterCluster Deletes an OpenShift bare metal cluster definition. */
DeregisterCluster(ctx context.Context, params installer.DeregisterClusterParams) middleware.Responder
/* DeregisterHost Deregisters an OpenShift bare metal host. */
DeregisterHost(ctx context.Context, params installer.DeregisterHostParams) middleware.Responder
/* DisableHost Disables a host for inclusion in the cluster. */
DisableHost(ctx context.Context, params installer.DisableHostParams) middleware.Responder
/* DownloadClusterFiles Downloads files relating to the installed/installing cluster. */
DownloadClusterFiles(ctx context.Context, params installer.DownloadClusterFilesParams) middleware.Responder
/* DownloadClusterISO Downloads the OpenShift per-cluster discovery ISO. */
DownloadClusterISO(ctx context.Context, params installer.DownloadClusterISOParams) middleware.Responder
/* DownloadClusterKubeconfig Downloads the kubeconfig file for this cluster. */
DownloadClusterKubeconfig(ctx context.Context, params installer.DownloadClusterKubeconfigParams) middleware.Responder
/* DownloadClusterLogs Download cluster logs */
DownloadClusterLogs(ctx context.Context, params installer.DownloadClusterLogsParams) middleware.Responder
/* DownloadHostLogs Download host logs */
DownloadHostLogs(ctx context.Context, params installer.DownloadHostLogsParams) middleware.Responder
/* EnableHost Enables a host for inclusion in the cluster. */
EnableHost(ctx context.Context, params installer.EnableHostParams) middleware.Responder
/* GenerateClusterISO Creates a new OpenShift per-cluster discovery ISO. */
GenerateClusterISO(ctx context.Context, params installer.GenerateClusterISOParams) middleware.Responder
/* GetCluster Retrieves the details of the OpenShift bare metal cluster. */
GetCluster(ctx context.Context, params installer.GetClusterParams) middleware.Responder
/* GetCredentials Get the the cluster admin credentials. */
GetCredentials(ctx context.Context, params installer.GetCredentialsParams) middleware.Responder
/* GetFreeAddresses Retrieves the free address list for a network. */
GetFreeAddresses(ctx context.Context, params installer.GetFreeAddressesParams) middleware.Responder
/* GetHost Retrieves the details of the OpenShift bare metal host. */
GetHost(ctx context.Context, params installer.GetHostParams) middleware.Responder
/* GetHostRequirements Get minimum host requirements */
GetHostRequirements(ctx context.Context, params installer.GetHostRequirementsParams) middleware.Responder
/* GetNextSteps Retrieves the next operations that the host agent needs to perform. */
GetNextSteps(ctx context.Context, params installer.GetNextStepsParams) middleware.Responder
/* GetPresignedForClusterFiles Retrieves a presigned S3 URL for downloading cluster files. */
GetPresignedForClusterFiles(ctx context.Context, params installer.GetPresignedForClusterFilesParams) middleware.Responder
/* InstallCluster Installs the OpenShift bare metal cluster. */
InstallCluster(ctx context.Context, params installer.InstallClusterParams) middleware.Responder
/* ListClusters Retrieves the list of OpenShift bare metal clusters. */
ListClusters(ctx context.Context, params installer.ListClustersParams) middleware.Responder
/* ListHosts Retrieves the list of OpenShift bare metal hosts. */
ListHosts(ctx context.Context, params installer.ListHostsParams) middleware.Responder
/* PostStepReply Posts the result of the operations from the host agent. */
PostStepReply(ctx context.Context, params installer.PostStepReplyParams) middleware.Responder
/* RegisterCluster Creates a new OpenShift bare metal cluster definition. */
RegisterCluster(ctx context.Context, params installer.RegisterClusterParams) middleware.Responder
/* RegisterHost Registers a new OpenShift bare metal host. */
RegisterHost(ctx context.Context, params installer.RegisterHostParams) middleware.Responder
/* ResetCluster Resets a failed installation. */
ResetCluster(ctx context.Context, params installer.ResetClusterParams) middleware.Responder
/* UpdateCluster Updates an OpenShift bare metal cluster definition. */
UpdateCluster(ctx context.Context, params installer.UpdateClusterParams) middleware.Responder
/* UpdateClusterInstallConfig Override values in the install config */
UpdateClusterInstallConfig(ctx context.Context, params installer.UpdateClusterInstallConfigParams) middleware.Responder
/* UpdateHostInstallProgress Update installation progress */
UpdateHostInstallProgress(ctx context.Context, params installer.UpdateHostInstallProgressParams) middleware.Responder
/* UploadClusterIngressCert Transfer the ingress certificate for the cluster. */
UploadClusterIngressCert(ctx context.Context, params installer.UploadClusterIngressCertParams) middleware.Responder
/* UploadHostLogs Agent API to upload logs. */
UploadHostLogs(ctx context.Context, params installer.UploadHostLogsParams) middleware.Responder
}
InstallerAPI
type ManagedDomainsAPI ¶
type ManagedDomainsAPI interface {
/* ListManagedDomains List of managed DNS domains */
ListManagedDomains(ctx context.Context, params managed_domains.ListManagedDomainsParams) middleware.Responder
}
ManagedDomainsAPI
type VersionsAPI ¶
type VersionsAPI interface {
/* ListComponentVersions List of componenets versions */
ListComponentVersions(ctx context.Context, params versions.ListComponentVersionsParams) middleware.Responder
}
VersionsAPI
Click to show internal directories.
Click to hide internal directories.