github.com/m3db/m3@v1.5.0/src/cluster/placementhandler/handleroptions/allowed_services.go (about)

     1  // Copyright (c) 2019 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package handleroptions
    22  
    23  type allowedServicesSet map[string]struct{}
    24  
    25  func (a allowedServicesSet) String() []string {
    26  	s := make([]string, 0, len(a))
    27  	for key := range a {
    28  		s = append(s, key)
    29  	}
    30  	return s
    31  }
    32  
    33  var (
    34  	allowedServices = allowedServicesSet{
    35  		M3DBServiceName:          struct{}{},
    36  		M3AggregatorServiceName:  struct{}{},
    37  		M3CoordinatorServiceName: struct{}{},
    38  	}
    39  )
    40  
    41  // IsAllowedService returns whether a service name is a valid M3 service.
    42  func IsAllowedService(svc string) bool {
    43  	_, ok := allowedServices[svc]
    44  	return ok
    45  }
    46  
    47  // AllowedServices returns the list of valid M3 services.
    48  func AllowedServices() []string {
    49  	svcs := make([]string, 0, len(allowedServices))
    50  	for svc := range allowedServices {
    51  		svcs = append(svcs, svc)
    52  	}
    53  	return svcs
    54  }