Skip to content

Commit

Permalink
refactor: update readme for security group name update
Browse files Browse the repository at this point in the history
  • Loading branch information
JGSweets committed May 7, 2024
1 parent 9c8fa30 commit e644f58
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions docs/source/reference/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,27 @@ Available fields and semantics:
# Security group (optional).
#
# The name of the security group to use for all instances. If not specified,
# Security group name to use for AWS instances. If not specified,
# SkyPilot will use the default name for the security group: sky-sg-<hash>
# Note: please ensure the security group name specified exists in the
# regions the instances are going to be launched or the AWS account has the
# permission to create a security group.
#
# Some example use cases are shown below. All fields are optional.
# - <string>: apply the service account with the specified name to all instances.
# Example:
# security_group_name: my-security-group
# - <list of single-element dict>: A list of single-element dict mapping from the cluster name (pattern)
# to the security group name to use. The matching of the cluster name is done in the same order
# as the list.
# NOTE: If none of the wildcard expressions in the dict match the cluster name, SkyPilot will use the default
# security group name as mentioned above: sky-sg-<hash>
# To specify your default, use "*" as the wildcard expression.
# Example:
# security_group_name:
# - my-cluster-name: my-security-group-1
# - sky-serve-controller-*: my-security-group-2
# - "*": my-default-security-group
security_group_name: my-security-group
# Identity to use for AWS instances (optional).
Expand Down Expand Up @@ -205,21 +221,21 @@ Available fields and semantics:
# Reserved capacity (optional).
#
#
# Whether to prioritize reserved instance types/locations (considered as 0
# cost) in the optimizer.
#
#
# If you have "automatically consumed" reservations in your GCP project:
# Setting this to true guarantees the optimizer will pick any matching
# reservation and GCP will auto consume your reservation, and setting to
# false means optimizer uses regular, non-zero pricing in optimization (if
# by chance any matching reservation is selected, GCP still auto consumes
# the reservation).
#
#
# If you have "specifically targeted" reservations (set by the
# `specific_reservations` field below): This field will automatically be set
# to true.
#
#
# Default: false.
prioritize_reservations: false
#
Expand Down Expand Up @@ -401,4 +417,3 @@ Available fields and semantics:
us-ashburn-1:
vcn_subnet: ocid1.subnet.oc1.iad.aaaaaaaafbj7i3aqc4ofjaapa5edakde6g4ea2yaslcsay32cthp7qo55pxa

0 comments on commit e644f58

Please sign in to comment.