/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jclouds.chef.config;


/**
 * Configuration properties and constants used in Chef connections.
 */
public interface ChefProperties {

   /**
    * The name of the Chef logger.
    */
   public static final String CHEF_LOGGER = "jclouds.chef";

   /**
    * Databag that holds chef bootstrap hints, should be a json ball in the
    * following format:
    * <p>
    * {"tag":{"run_list":["recipe[apache2]"]}}
    */
   public static final String CHEF_BOOTSTRAP_DATABAG = "chef.bootstrap-databag";

   /**
    * The name of the validator client used to allow nodes to autoregister in
    * the Chef server.
    * <p>
    * This property must be set prior to running the
    * {@link ChefService#createBootstrapScriptForGroup(String)} method.
    */
   public static final String CHEF_VALIDATOR_NAME = "chef.validator-name";

   /**
    * The credential of the validator client used to allow nodes to autoregister
    * in the Chef server.
    * <p>
    * This property must be set prior to running the
    * {@link ChefService#createBootstrapScriptForGroup(String)} method.
    */
   public static final String CHEF_VALIDATOR_CREDENTIAL = "chef.validator-credential";

   /**
    * The version of the Chef gem to install when bootstrapping nodes.
    * <p>
    * If this property is not set, by default the latest available Chef gem will
    * be installed. The values can be fixed versions such as '0.10.8' or
    * constrained values such as '>= 0.10.8'.
    * <p>
    * This property must be set prior to running the
    * {@link ChefService#createBootstrapScriptForGroup(String)} method.
    */
   public static final String CHEF_VERSION = "chef.version";

   /**
    * Boolean property. Default (false).
    * <p>
    * When bootstrapping a node, forces a gem system update before installing
    * the Chef gems.
    * <p>
    * This property must be set prior to running the
    * {@link ChefService#createBootstrapScriptForGroup(String)} method.
    */
   public static final String CHEF_UPDATE_GEM_SYSTEM = "chef.update-gem-system";

   /**
    * To be used in conjunction with {@link #CHEF_UPDATE_GEM_SYSTEM}. This
    * property will force the version of RubyGems to update the system to.
    * <p>
    * This property must be set prior to running the
    * {@link ChefService#createBootstrapScriptForGroup(String)} method.
    */
   public static final String CHEF_GEM_SYSTEM_VERSION = "chef.gem-system-version";

   /**
    * Boolean property. Default (false).
    * <p>
    * When bootstrapping a node, updates the existing gems before installing
    * Chef.
    * <p>
    * This property must be set prior to running the
    * {@link ChefService#createBootstrapScriptForGroup(String)} method.
    */
   public static final String CHEF_UPDATE_GEMS = "chef.update-gems";

   /**
    * Boolean property. Default (true).
    * <p>
    * When bootstrapping a node, install the Chef client using the Omnibus
    * installer.
    * <p>
    * This property must be set prior to running the
    * {@link ChefService#createBootstrapScriptForGroup(String)} method.
    */
   public static final String CHEF_USE_OMNIBUS = "chef.use-omnibus";

}