github.com/docker/compose-on-kubernetes@v0.5.0/api/compose/latest/aliases.go (about)

     1  package latest
     2  
     3  import (
     4  	ref "github.com/docker/compose-on-kubernetes/api/compose/v1alpha3"
     5  	"k8s.io/apimachinery/pkg/runtime/schema"
     6  )
     7  
     8  // Constraint defines a constraint and it's operator (== or !=)
     9  type Constraint = ref.Constraint
    10  
    11  // RestartPolicy is the service restart policy
    12  type RestartPolicy = ref.RestartPolicy
    13  
    14  // Stack is v1alpha3's representation of a Stack
    15  type Stack = ref.Stack
    16  
    17  // Scale contains the current/desired replica count for services in a stack.
    18  type Scale = ref.Scale
    19  
    20  // SecretConfig for a secret
    21  type SecretConfig = ref.SecretConfig
    22  
    23  // ServiceConfig is the configuration of one service
    24  type ServiceConfig = ref.ServiceConfig
    25  
    26  // ComposeFile is the content of a stack's compose file if any
    27  type ComposeFile = ref.ComposeFile
    28  
    29  // External identifies a Volume or Network as a reference to a resource that is
    30  // not managed, and should already exist.
    31  // External.name is deprecated and replaced by Volume.name
    32  type External = ref.External
    33  
    34  // UpdateConfig is the service update configuration
    35  type UpdateConfig = ref.UpdateConfig
    36  
    37  // ServicePortConfig is the port configuration for a service
    38  type ServicePortConfig = ref.ServicePortConfig
    39  
    40  // StackList is a list of stacks
    41  type StackList = ref.StackList
    42  
    43  // Placement constraints for the service
    44  type Placement = ref.Placement
    45  
    46  // ServiceConfigObjConfig is the config obj configuration for a service
    47  type ServiceConfigObjConfig = ref.ServiceConfigObjConfig
    48  
    49  // ServiceSecretConfig is the secret configuration for a service
    50  type ServiceSecretConfig = ref.ServiceSecretConfig
    51  
    52  // StackSpec defines the desired state of Stack
    53  type StackSpec = ref.StackSpec
    54  
    55  // StackPhase is the deployment phase of a stack
    56  type StackPhase = ref.StackPhase
    57  
    58  // FileObjectConfig is a config type for a file used by a service
    59  type FileObjectConfig = ref.FileObjectConfig
    60  
    61  // HealthCheckConfig the healthcheck configuration for a service
    62  type HealthCheckConfig = ref.HealthCheckConfig
    63  
    64  // StackStatus defines the observed state of Stack
    65  type StackStatus = ref.StackStatus
    66  
    67  // ConfigObjConfig is the config for the swarm "Config" object
    68  type ConfigObjConfig = ref.ConfigObjConfig
    69  
    70  // Constraints lists constraints that can be set on the service
    71  type Constraints = ref.Constraints
    72  
    73  // DeployConfig is the deployment configuration for a service
    74  type DeployConfig = ref.DeployConfig
    75  
    76  // Resource is a resource to be limited or reserved
    77  type Resource = ref.Resource
    78  
    79  // ServiceVolumeConfig are references to a volume used by a service
    80  type ServiceVolumeConfig = ref.ServiceVolumeConfig
    81  
    82  // Owner describes the user who created the stack
    83  type Owner = ref.Owner
    84  
    85  // Resources the resource limits and reservations
    86  type Resources = ref.Resources
    87  
    88  // FileReferenceConfig for a reference to a swarm file object
    89  type FileReferenceConfig = ref.FileReferenceConfig
    90  
    91  // InternalPort describes a Port exposed internally to other services
    92  // in the stack
    93  type InternalPort = ref.InternalPort
    94  
    95  // InternalServiceType defines the strategy for defining the Service Type to use for inter-service networking
    96  type InternalServiceType = ref.InternalServiceType
    97  
    98  // These are valid conditions of a stack.
    99  const (
   100  	// StackAvailable means the stack is available.
   101  	StackAvailable StackPhase = "Available"
   102  	// StackProgressing means the deployment is progressing.
   103  	StackProgressing StackPhase = "Progressing"
   104  	// StackFailure is added in a stack when one of its members fails to be created
   105  	// or deleted.
   106  	StackFailure StackPhase = "Failure"
   107  	// StackReconciliationPending means the stack has not yet been reconciled
   108  	StackReconciliationPending StackPhase = "ReconciliationPending"
   109  
   110  	// InternalServiceTypeAuto behavior is the same as InternalServiceTypeHeadless if InternalPorts is empty, InternalServiceTypeClusterIP otherwise
   111  	InternalServiceTypeAuto = InternalServiceType("")
   112  	// InternalServiceTypeHeadless always create a Headless service
   113  	InternalServiceTypeHeadless = InternalServiceType("Headless")
   114  	// InternalServiceTypeClusterIP always create a ClusterIP service
   115  	InternalServiceTypeClusterIP = InternalServiceType("ClusterIP")
   116  )
   117  
   118  var (
   119  	// SchemeGroupVersion is group version used to register these objects
   120  	SchemeGroupVersion = ref.SchemeGroupVersion
   121  	// SchemeBuilder is the scheme builder
   122  	SchemeBuilder = ref.SchemeBuilder
   123  	// AddToScheme adds to scheme
   124  	AddToScheme = ref.AddToScheme
   125  )
   126  
   127  // GroupResource takes an unqualified resource and returns a Group qualified GroupResource
   128  func GroupResource(resource string) schema.GroupResource {
   129  	return ref.GroupResource(resource)
   130  }