golden hour
/opt/saltstack/salt/lib/python3.10/site-packages/salt/states
⬆️ Go Up
Upload
File/Folder
Size
Actions
__init__.py
25 B
Del
OK
__pycache__
-
Del
OK
acme.py
5.08 KB
Del
OK
alias.py
2.49 KB
Del
OK
alternatives.py
6.75 KB
Del
OK
ansiblegate.py
7.93 KB
Del
OK
apache.py
3.95 KB
Del
OK
apache_conf.py
2.72 KB
Del
OK
apache_module.py
2.73 KB
Del
OK
apache_site.py
2.66 KB
Del
OK
aptpkg.py
1.42 KB
Del
OK
archive.py
68.24 KB
Del
OK
artifactory.py
6.84 KB
Del
OK
at.py
7.48 KB
Del
OK
augeas.py
10.57 KB
Del
OK
aws_sqs.py
2.59 KB
Del
OK
azurearm_compute.py
11.78 KB
Del
OK
azurearm_dns.py
26.05 KB
Del
OK
azurearm_network.py
89.12 KB
Del
OK
azurearm_resource.py
28.23 KB
Del
OK
beacon.py
7.58 KB
Del
OK
bigip.py
96.63 KB
Del
OK
blockdev.py
5.13 KB
Del
OK
boto3_elasticache.py
48.01 KB
Del
OK
boto3_elasticsearch.py
32.58 KB
Del
OK
boto3_route53.py
37.54 KB
Del
OK
boto3_sns.py
12.69 KB
Del
OK
boto_apigateway.py
82.83 KB
Del
OK
boto_asg.py
31.93 KB
Del
OK
boto_cfn.py
11.53 KB
Del
OK
boto_cloudfront.py
6.01 KB
Del
OK
boto_cloudtrail.py
13.18 KB
Del
OK
boto_cloudwatch_alarm.py
6.4 KB
Del
OK
boto_cloudwatch_event.py
12.33 KB
Del
OK
boto_cognitoidentity.py
13.69 KB
Del
OK
boto_datapipeline.py
18.5 KB
Del
OK
boto_dynamodb.py
29.32 KB
Del
OK
boto_ec2.py
71.98 KB
Del
OK
boto_elasticache.py
16.75 KB
Del
OK
boto_elasticsearch_domain.py
12.27 KB
Del
OK
boto_elb.py
55.1 KB
Del
OK
boto_elbv2.py
12.19 KB
Del
OK
boto_iam.py
69.16 KB
Del
OK
boto_iam_role.py
27.12 KB
Del
OK
boto_iot.py
25.33 KB
Del
OK
boto_kinesis.py
16.69 KB
Del
OK
boto_kms.py
12.11 KB
Del
OK
boto_lambda.py
35.52 KB
Del
OK
boto_lc.py
11.04 KB
Del
OK
boto_rds.py
26 KB
Del
OK
boto_route53.py
19.49 KB
Del
OK
boto_s3.py
9.32 KB
Del
OK
boto_s3_bucket.py
24.67 KB
Del
OK
boto_secgroup.py
32.62 KB
Del
OK
boto_sns.py
8.92 KB
Del
OK
boto_sqs.py
7.97 KB
Del
OK
boto_vpc.py
62.23 KB
Del
OK
bower.py
8.26 KB
Del
OK
btrfs.py
10.34 KB
Del
OK
cabal.py
5.73 KB
Del
OK
ceph.py
1.9 KB
Del
OK
chef.py
3.76 KB
Del
OK
chocolatey.py
16.15 KB
Del
OK
chronos_job.py
4.6 KB
Del
OK
cimc.py
14.32 KB
Del
OK
cisconso.py
3.14 KB
Del
OK
cloud.py
14.4 KB
Del
OK
cmd.py
40.92 KB
Del
OK
composer.py
8.38 KB
Del
OK
consul.py
5.4 KB
Del
OK
cron.py
23.39 KB
Del
OK
cryptdev.py
6.17 KB
Del
OK
csf.py
9.98 KB
Del
OK
cyg.py
7.05 KB
Del
OK
ddns.py
4.2 KB
Del
OK
debconfmod.py
6.33 KB
Del
OK
dellchassis.py
24.49 KB
Del
OK
disk.py
6.49 KB
Del
OK
docker_container.py
85.27 KB
Del
OK
docker_image.py
16.7 KB
Del
OK
docker_network.py
36.78 KB
Del
OK
docker_volume.py
6.72 KB
Del
OK
drac.py
4.17 KB
Del
OK
dvs.py
26.29 KB
Del
OK
elasticsearch.py
20.38 KB
Del
OK
elasticsearch_index.py
3.25 KB
Del
OK
elasticsearch_index_template.py
3.67 KB
Del
OK
environ.py
5.81 KB
Del
OK
eselect.py
2.27 KB
Del
OK
esxcluster.py
22.4 KB
Del
OK
esxdatacenter.py
4.44 KB
Del
OK
esxi.py
63.07 KB
Del
OK
esxvm.py
20.11 KB
Del
OK
etcd_mod.py
11 KB
Del
OK
ethtool.py
9.88 KB
Del
OK
event.py
2.48 KB
Del
OK
file.py
316.7 KB
Del
OK
firewall.py
1.33 KB
Del
OK
firewalld.py
26.08 KB
Del
OK
gem.py
7.13 KB
Del
OK
git.py
123.85 KB
Del
OK
github.py
27.25 KB
Del
OK
glance_image.py
2.26 KB
Del
OK
glassfish.py
21.47 KB
Del
OK
glusterfs.py
12.21 KB
Del
OK
gnomedesktop.py
7.47 KB
Del
OK
gpg.py
5.28 KB
Del
OK
grafana.py
12.11 KB
Del
OK
grafana4_dashboard.py
17.31 KB
Del
OK
grafana4_datasource.py
6.15 KB
Del
OK
grafana4_org.py
7.73 KB
Del
OK
grafana4_user.py
5.52 KB
Del
OK
grafana_dashboard.py
17.74 KB
Del
OK
grafana_datasource.py
5.31 KB
Del
OK
grains.py
15.57 KB
Del
OK
group.py
9.84 KB
Del
OK
heat.py
9.69 KB
Del
OK
helm.py
10.39 KB
Del
OK
hg.py
6.33 KB
Del
OK
highstate_doc.py
1.41 KB
Del
OK
host.py
8.64 KB
Del
OK
http.py
7.46 KB
Del
OK
icinga2.py
9.07 KB
Del
OK
idem.py
3.91 KB
Del
OK
ifttt.py
2.12 KB
Del
OK
incron.py
5.71 KB
Del
OK
influxdb08_database.py
2.85 KB
Del
OK
influxdb08_user.py
3.39 KB
Del
OK
influxdb_continuous_query.py
2.83 KB
Del
OK
influxdb_database.py
2.11 KB
Del
OK
influxdb_retention_policy.py
4.82 KB
Del
OK
influxdb_user.py
4.84 KB
Del
OK
infoblox_a.py
4.24 KB
Del
OK
infoblox_cname.py
4.19 KB
Del
OK
infoblox_host_record.py
6.59 KB
Del
OK
infoblox_range.py
6.85 KB
Del
OK
ini_manage.py
12.67 KB
Del
OK
ipmi.py
8.42 KB
Del
OK
ipset.py
9.66 KB
Del
OK
iptables.py
27.65 KB
Del
OK
jboss7.py
23.95 KB
Del
OK
jenkins.py
3.36 KB
Del
OK
junos.py
17.78 KB
Del
OK
kapacitor.py
6.46 KB
Del
OK
kernelpkg.py
6.42 KB
Del
OK
keyboard.py
2.01 KB
Del
OK
keystone.py
27.12 KB
Del
OK
keystone_domain.py
2.81 KB
Del
OK
keystone_endpoint.py
4.69 KB
Del
OK
keystone_group.py
3.25 KB
Del
OK
keystone_project.py
3.36 KB
Del
OK
keystone_role.py
2.33 KB
Del
OK
keystone_role_grant.py
4.08 KB
Del
OK
keystone_service.py
2.89 KB
Del
OK
keystone_user.py
3.47 KB
Del
OK
keystore.py
5.67 KB
Del
OK
kmod.py
8.59 KB
Del
OK
kubernetes.py
24.87 KB
Del
OK
layman.py
2.44 KB
Del
OK
ldap.py
19.78 KB
Del
OK
libcloud_dns.py
5.7 KB
Del
OK
libcloud_loadbalancer.py
5.66 KB
Del
OK
libcloud_storage.py
5.13 KB
Del
OK
linux_acl.py
24.42 KB
Del
OK
locale.py
2.52 KB
Del
OK
logadm.py
4.67 KB
Del
OK
logrotate.py
3.86 KB
Del
OK
loop.py
7.74 KB
Del
OK
lvm.py
13.33 KB
Del
OK
lvs_server.py
6.28 KB
Del
OK
lvs_service.py
4.38 KB
Del
OK
lxc.py
22.17 KB
Del
OK
lxd.py
7.88 KB
Del
OK
lxd_container.py
22.25 KB
Del
OK
lxd_image.py
10.59 KB
Del
OK
lxd_profile.py
7.11 KB
Del
OK
mac_assistive.py
1.55 KB
Del
OK
mac_keychain.py
5.59 KB
Del
OK
mac_xattr.py
3.15 KB
Del
OK
macdefaults.py
2.65 KB
Del
OK
macpackage.py
6.76 KB
Del
OK
makeconf.py
6.87 KB
Del
OK
marathon_app.py
4.45 KB
Del
OK
mdadm_raid.py
6.41 KB
Del
OK
memcached.py
3.95 KB
Del
OK
modjk.py
2.84 KB
Del
OK
modjk_worker.py
6.49 KB
Del
OK
module.py
18.64 KB
Del
OK
mongodb_database.py
1.65 KB
Del
OK
mongodb_user.py
6.26 KB
Del
OK
monit.py
2.68 KB
Del
OK
mount.py
50.32 KB
Del
OK
mssql_database.py
3 KB
Del
OK
mssql_login.py
3.64 KB
Del
OK
mssql_role.py
2.37 KB
Del
OK
mssql_user.py
3.51 KB
Del
OK
msteams.py
2.53 KB
Del
OK
mysql_database.py
6.05 KB
Del
OK
mysql_grants.py
8.49 KB
Del
OK
mysql_query.py
13.07 KB
Del
OK
mysql_user.py
9.51 KB
Del
OK
net_napalm_yang.py
9.15 KB
Del
OK
netacl.py
31.92 KB
Del
OK
netconfig.py
33.42 KB
Del
OK
netntp.py
12.51 KB
Del
OK
netsnmp.py
11.33 KB
Del
OK
netusers.py
16.1 KB
Del
OK
network.py
23.97 KB
Del
OK
neutron_network.py
3.96 KB
Del
OK
neutron_secgroup.py
4 KB
Del
OK
neutron_secgroup_rule.py
4.75 KB
Del
OK
neutron_subnet.py
4.29 KB
Del
OK
nexus.py
4.97 KB
Del
OK
nfs_export.py
4.92 KB
Del
OK
nftables.py
19.5 KB
Del
OK
npm.py
11.21 KB
Del
OK
ntp.py
2.12 KB
Del
OK
nxos.py
10.37 KB
Del
OK
nxos_upgrade.py
3.5 KB
Del
OK
openstack_config.py
3.26 KB
Del
OK
openvswitch_bridge.py
4.36 KB
Del
OK
openvswitch_db.py
2.24 KB
Del
OK
openvswitch_port.py
17.24 KB
Del
OK
opsgenie.py
4.07 KB
Del
OK
pagerduty.py
1.89 KB
Del
OK
pagerduty_escalation_policy.py
5.42 KB
Del
OK
pagerduty_schedule.py
6.09 KB
Del
OK
pagerduty_service.py
3.93 KB
Del
OK
pagerduty_user.py
1.18 KB
Del
OK
panos.py
48.13 KB
Del
OK
pbm.py
20.46 KB
Del
OK
pcs.py
36.46 KB
Del
OK
pdbedit.py
3.43 KB
Del
OK
pecl.py
3.65 KB
Del
OK
pip_state.py
38.55 KB
Del
OK
pkg.py
138.08 KB
Del
OK
pkgbuild.py
11.37 KB
Del
OK
pkgng.py
685 B
Del
OK
pkgrepo.py
27.53 KB
Del
OK
portage_config.py
5.01 KB
Del
OK
ports.py
5.65 KB
Del
OK
postgres_cluster.py
4.19 KB
Del
OK
postgres_database.py
6.08 KB
Del
OK
postgres_extension.py
5.68 KB
Del
OK
postgres_group.py
8.52 KB
Del
OK
postgres_initdb.py
2.84 KB
Del
OK
postgres_language.py
3.94 KB
Del
OK
postgres_privileges.py
7.86 KB
Del
OK
postgres_schema.py
4.34 KB
Del
OK
postgres_tablespace.py
6.62 KB
Del
OK
postgres_user.py
9.49 KB
Del
OK
powerpath.py
2.34 KB
Del
OK
probes.py
15.06 KB
Del
OK
process.py
1.32 KB
Del
OK
proxy.py
4.94 KB
Del
OK
pushover.py
3.13 KB
Del
OK
pyenv.py
6.07 KB
Del
OK
pyrax_queues.py
2.97 KB
Del
OK
quota.py
1.4 KB
Del
OK
rabbitmq_cluster.py
1.84 KB
Del
OK
rabbitmq_plugin.py
2.77 KB
Del
OK
rabbitmq_policy.py
4.59 KB
Del
OK
rabbitmq_upstream.py
7.9 KB
Del
OK
rabbitmq_user.py
8.89 KB
Del
OK
rabbitmq_vhost.py
3.04 KB
Del
OK
rbac_solaris.py
6.67 KB
Del
OK
rbenv.py
7.36 KB
Del
OK
rdp.py
1.28 KB
Del
OK
redismod.py
4.76 KB
Del
OK
reg.py
19.22 KB
Del
OK
restconf.py
6.41 KB
Del
OK
rsync.py
4.45 KB
Del
OK
rvm.py
6.56 KB
Del
OK
salt_proxy.py
1.34 KB
Del
OK
saltmod.py
33.12 KB
Del
OK
saltutil.py
8.91 KB
Del
OK
schedule.py
12.47 KB
Del
OK
selinux.py
18.61 KB
Del
OK
serverdensity_device.py
6.41 KB
Del
OK
service.py
37.89 KB
Del
OK
slack.py
4.98 KB
Del
OK
smartos.py
44.83 KB
Del
OK
smtp.py
2.3 KB
Del
OK
snapper.py
7.24 KB
Del
OK
solrcloud.py
4.48 KB
Del
OK
splunk.py
4.32 KB
Del
OK
splunk_search.py
3.17 KB
Del
OK
sqlite3.py
14.7 KB
Del
OK
ssh_auth.py
19.57 KB
Del
OK
ssh_known_hosts.py
7.92 KB
Del
OK
stateconf.py
494 B
Del
OK
status.py
2.21 KB
Del
OK
statuspage.py
17.29 KB
Del
OK
supervisord.py
10.48 KB
Del
OK
svn.py
8.14 KB
Del
OK
sysctl.py
4.11 KB
Del
OK
sysfs.py
2.13 KB
Del
OK
syslog_ng.py
2.97 KB
Del
OK
sysrc.py
2.82 KB
Del
OK
telemetry_alert.py
7.04 KB
Del
OK
test.py
13.09 KB
Del
OK
testinframod.py
1.35 KB
Del
OK
timezone.py
3.42 KB
Del
OK
tls.py
1.81 KB
Del
OK
tomcat.py
9.72 KB
Del
OK
trafficserver.py
8.82 KB
Del
OK
tuned.py
3.32 KB
Del
OK
uptime.py
1.87 KB
Del
OK
user.py
38.63 KB
Del
OK
vagrant.py
11.4 KB
Del
OK
vault.py
3.28 KB
Del
OK
vbox_guest.py
4.05 KB
Del
OK
victorops.py
3.32 KB
Del
OK
virt.py
80.41 KB
Del
OK
virtualenv_mod.py
11.21 KB
Del
OK
webutil.py
3.89 KB
Del
OK
win_certutil.py
4.8 KB
Del
OK
win_dacl.py
7.96 KB
Del
OK
win_dism.py
14.97 KB
Del
OK
win_dns_client.py
8.32 KB
Del
OK
win_firewall.py
6.87 KB
Del
OK
win_iis.py
31.56 KB
Del
OK
win_lgpo.py
24.99 KB
Del
OK
win_lgpo_reg.py
10.96 KB
Del
OK
win_license.py
1.6 KB
Del
OK
win_network.py
14.18 KB
Del
OK
win_path.py
6.39 KB
Del
OK
win_pki.py
5.56 KB
Del
OK
win_powercfg.py
3.79 KB
Del
OK
win_servermanager.py
10.4 KB
Del
OK
win_shortcut.py
7.81 KB
Del
OK
win_smtp_server.py
10.01 KB
Del
OK
win_snmp.py
6.64 KB
Del
OK
win_system.py
13.78 KB
Del
OK
win_wua.py
16.27 KB
Del
OK
win_wusa.py
3.53 KB
Del
OK
winrepo.py
2.74 KB
Del
OK
wordpress.py
4.82 KB
Del
OK
x509.py
27.86 KB
Del
OK
x509_v2.py
64.78 KB
Del
OK
xml.py
1.75 KB
Del
OK
xmpp.py
2.61 KB
Del
OK
zabbix_action.py
9.35 KB
Del
OK
zabbix_host.py
27.25 KB
Del
OK
zabbix_hostgroup.py
5.64 KB
Del
OK
zabbix_mediatype.py
16.89 KB
Del
OK
zabbix_template.py
35.14 KB
Del
OK
zabbix_user.py
17.6 KB
Del
OK
zabbix_usergroup.py
9.64 KB
Del
OK
zabbix_usermacro.py
9.69 KB
Del
OK
zabbix_valuemap.py
8.11 KB
Del
OK
zcbuildout.py
5.16 KB
Del
OK
zenoss.py
2.89 KB
Del
OK
zfs.py
34.48 KB
Del
OK
zk_concurrency.py
5.81 KB
Del
OK
zone.py
46.48 KB
Del
OK
zookeeper.py
11.55 KB
Del
OK
zpool.py
13.4 KB
Del
OK
Edit: github.py
""" Github User State Module .. versionadded:: 2016.3.0 This state is used to ensure presence of users in the Organization. .. code-block:: yaml ensure user test is present in github: github.present: - name: 'Example TestUser1' - email: example@domain.com - username: 'gitexample' """ import datetime import logging import time from salt.exceptions import CommandExecutionError log = logging.getLogger(__name__) def __virtual__(): """ Only load if the github module is available in __salt__ """ if "github.list_users" in __salt__: return "github" return (False, "github module could not be loaded") def present(name, profile="github", **kwargs): """ Ensure a user is present .. code-block:: yaml ensure user test is present in github: github.present: - name: 'gitexample' The following parameters are required: name This is the github handle of the user in the organization """ ret = {"name": name, "changes": {}, "result": None, "comment": ""} target = __salt__["github.get_user"](name, profile=profile, **kwargs) # If the user has a valid github handle and is not in the org already if not target: ret["result"] = False ret["comment"] = "Couldnt find user {}".format(name) elif isinstance(target, bool) and target: ret["comment"] = "User {} is already in the org ".format(name) ret["result"] = True elif ( not target.get("in_org", False) and target.get("membership_state") != "pending" ): if __opts__["test"]: ret["comment"] = "User {} will be added to the org".format(name) return ret # add the user result = __salt__["github.add_user"](name, profile=profile, **kwargs) if result: ret["changes"].setdefault("old", None) ret["changes"].setdefault( "new", "User {} exists in the org now".format(name) ) ret["result"] = True else: ret["result"] = False ret["comment"] = "Failed to add user {} to the org".format(name) else: ret["comment"] = "User {} has already been invited.".format(name) ret["result"] = True return ret def absent(name, profile="github", **kwargs): """ Ensure a github user is absent .. code-block:: yaml ensure user test is absent in github: github.absent: - name: 'Example TestUser1' - email: example@domain.com - username: 'gitexample' The following parameters are required: name Github handle of the user in organization """ email = kwargs.get("email") full_name = kwargs.get("fullname") ret = { "name": name, "changes": {}, "result": None, "comment": "User {} is absent.".format(name), } target = __salt__["github.get_user"](name, profile=profile, **kwargs) if target: if isinstance(target, bool) or target.get("in_org", False): if __opts__["test"]: ret["comment"] = "User {} will be deleted".format(name) ret["result"] = None return ret result = __salt__["github.remove_user"](name, profile=profile, **kwargs) if result: ret["comment"] = "Deleted user {}".format(name) ret["changes"].setdefault("old", "User {} exists".format(name)) ret["changes"].setdefault("new", "User {} deleted".format(name)) ret["result"] = True else: ret["comment"] = "Failed to delete {}".format(name) ret["result"] = False else: ret["comment"] = "User {} has already been deleted!".format(name) ret["result"] = True else: ret["comment"] = "User {} does not exist".format(name) ret["result"] = True return ret return ret def team_present( name, description=None, repo_names=None, privacy="secret", permission="pull", members=None, enforce_mfa=False, no_mfa_grace_seconds=0, profile="github", **kwargs ): """ Ensure a team is present name This is the name of the team in the organization. description The description of the team. repo_names The names of repositories to add the team to. privacy The level of privacy for the team, can be 'secret' or 'closed'. Defaults to secret. permission The default permission for new repositories added to the team, can be 'pull', 'push' or 'admin'. Defaults to pull. members The members belonging to the team, specified as a dict of member name to optional configuration. Options include 'enforce_mfa_from' and 'mfa_exempt'. enforce_mfa Whether to enforce MFA requirements on members of the team. If True then all members without `mfa_exempt: True` configured will be removed from the team. Note that `no_mfa_grace_seconds` may be set to allow members a grace period. no_mfa_grace_seconds The number of seconds of grace time that a member will have to enable MFA before being removed from the team. The grace period will begin from `enforce_mfa_from` on the member configuration, which defaults to 1970/01/01. Example: .. code-block:: yaml Ensure team test is present in github: github.team_present: - name: 'test' - members: user1: {} user2: {} Ensure team test_mfa is present in github: github.team_present: - name: 'test_mfa' - members: user1: enforce_mfa_from: 2016/06/15 - enforce_mfa: True .. versionadded:: 2016.11.0 """ ret = {"name": name, "changes": {}, "result": True, "comment": ""} target = __salt__["github.get_team"](name, profile=profile, **kwargs) test_comments = [] if target: # Team already exists parameters = {} if description is not None and target["description"] != description: parameters["description"] = description if permission is not None and target["permission"] != permission: parameters["permission"] = permission if privacy is not None and target["privacy"] != privacy: parameters["privacy"] = privacy if len(parameters) > 0: if __opts__["test"]: test_comments.append( "Team properties are set to be edited: {}".format(parameters) ) ret["result"] = None else: result = __salt__["github.edit_team"]( name, profile=profile, **parameters ) if result: ret["changes"]["team"] = { "old": "Team properties were {}".format(target), "new": "Team properties (that changed) are {}".format( parameters ), } else: ret["result"] = False ret["comment"] = "Failed to update team properties." return ret manage_repos = repo_names is not None current_repos = set( __salt__["github.list_team_repos"](name, profile=profile).keys() ) repo_names = set(repo_names or []) repos_to_add = repo_names - current_repos repos_to_remove = current_repos - repo_names if repo_names else [] if repos_to_add: if __opts__["test"]: test_comments.append( "Team {} will have the following repos added: {}.".format( name, list(repos_to_add) ) ) ret["result"] = None else: for repo_name in repos_to_add: result = __salt__["github.add_team_repo"]( repo_name, name, profile=profile, **kwargs ) if result: ret["changes"][repo_name] = { "old": "Repo {} is not in team {}".format(repo_name, name), "new": "Repo {} is in team {}".format(repo_name, name), } else: ret["result"] = False ret["comment"] = "Failed to add repo {} to team {}.".format( repo_name, name ) return ret if repos_to_remove: if __opts__["test"]: test_comments.append( "Team {} will have the following repos removed: {}.".format( name, list(repos_to_remove) ) ) ret["result"] = None else: for repo_name in repos_to_remove: result = __salt__["github.remove_team_repo"]( repo_name, name, profile=profile, **kwargs ) if result: ret["changes"][repo_name] = { "old": "Repo {} is in team {}".format(repo_name, name), "new": "Repo {} is not in team {}".format(repo_name, name), } else: ret["result"] = False ret[ "comment" ] = "Failed to remove repo {} from team {}.".format( repo_name, name ) return ret else: # Team does not exist - it will be created. if __opts__["test"]: ret["comment"] = "Team {} is set to be created.".format(name) ret["result"] = None return ret result = __salt__["github.add_team"]( name, description=description, repo_names=repo_names, permission=permission, privacy=privacy, profile=profile, **kwargs ) if result: ret["changes"]["team"] = {} ret["changes"]["team"]["old"] = None ret["changes"]["team"]["new"] = "Team {} has been created".format(name) else: ret["result"] = False ret["comment"] = "Failed to create team {}.".format(name) return ret manage_members = members is not None mfa_deadline = datetime.datetime.utcnow() - datetime.timedelta( seconds=no_mfa_grace_seconds ) members_no_mfa = __salt__["github.list_members_without_mfa"](profile=profile) members_lower = {} for member_name, info in members or {}.items(): members_lower[member_name.lower()] = info member_change = False current_members = __salt__["github.list_team_members"](name, profile=profile) for member, member_info in members or {}.items(): log.info("Checking member %s in team %s", member, name) if member.lower() not in current_members: if enforce_mfa and _member_violates_mfa( member, member_info, mfa_deadline, members_no_mfa ): if __opts__["test"]: test_comments.append( "User {} will not be added to the " "team because they do not have MFA." "".format(member) ) else: # Add to team member_change = True if __opts__["test"]: test_comments.append( "User {} set to be added to the team.".format(member) ) ret["result"] = None else: result = __salt__["github.add_team_member"]( member, name, profile=profile, **kwargs ) if result: ret["changes"][member] = {} ret["changes"][member][ "old" ] = "User {} is not in team {}".format(member, name) ret["changes"][member]["new"] = "User {} is in team {}".format( member, name ) else: ret["result"] = False ret["comment"] = "Failed to add user {} to team {}.".format( member, name ) return ret for member in current_members: mfa_violation = False if member in members_lower: mfa_violation = _member_violates_mfa( member, members_lower[member], mfa_deadline, members_no_mfa ) if ( manage_members and member not in members_lower or (enforce_mfa and mfa_violation) ): # Remove from team member_change = True if __opts__["test"]: if mfa_violation: test_comments.append( "User {} set to be removed from the " "team because they do not have MFA.".format(member) ) else: test_comments.append( "User {} set to be removed from the team.".format(member) ) ret["result"] = None else: result = __salt__["github.remove_team_member"]( member, name, profile=profile, **kwargs ) if result: extra_changes = " due to MFA violation" if mfa_violation else "" ret["changes"][member] = { "old": "User {} is in team {}".format(member, name), "new": "User {} is not in team {}{}".format( member, name, extra_changes ), } else: ret["result"] = False ret["comment"] = "Failed to remove user {} from team {}.".format( member, name ) return ret if member_change: # Refresh team cache __salt__["github.list_team_members"]( name, profile=profile, ignore_cache=False, **kwargs ) if len(test_comments) > 0: ret["comment"] = "\n".join(test_comments) return ret def _member_violates_mfa(member, member_info, mfa_deadline, members_without_mfa): if member_info.get("mfa_exempt", False): return False enforce_mfa_from = datetime.datetime.strptime( member_info.get("enforce_mfa_from", "1970/01/01"), "%Y/%m/%d" ) return member.lower() in members_without_mfa and (mfa_deadline > enforce_mfa_from) def team_absent(name, profile="github", **kwargs): """ Ensure a team is absent. Example: .. code-block:: yaml ensure team test is present in github: github.team_absent: - name: 'test' The following parameters are required: name This is the name of the team in the organization. .. versionadded:: 2016.11.0 """ ret = {"name": name, "changes": {}, "result": None, "comment": ""} target = __salt__["github.get_team"](name, profile=profile, **kwargs) if not target: ret["comment"] = "Team {} does not exist".format(name) ret["result"] = True return ret else: if __opts__["test"]: ret["comment"] = "Team {} will be deleted".format(name) ret["result"] = None return ret result = __salt__["github.remove_team"](name, profile=profile, **kwargs) if result: ret["comment"] = "Deleted team {}".format(name) ret["changes"].setdefault("old", "Team {} exists".format(name)) ret["changes"].setdefault("new", "Team {} deleted".format(name)) ret["result"] = True else: ret["comment"] = "Failed to delete {}".format(name) ret["result"] = False return ret def repo_present( name, description=None, homepage=None, private=None, has_issues=None, has_wiki=None, has_downloads=None, auto_init=False, gitignore_template=None, license_template=None, teams=None, profile="github", **kwargs ): """ Ensure a repository is present name This is the name of the repository. description The description of the repository. homepage The URL with more information about the repository. private The visiblity of the repository. Note that private repositories require a paid GitHub account. has_issues Whether to enable issues for this repository. has_wiki Whether to enable the wiki for this repository. has_downloads Whether to enable downloads for this repository. auto_init Whether to create an initial commit with an empty README. gitignore_template The desired language or platform for a .gitignore, e.g "Haskell". license_template The desired LICENSE template to apply, e.g "mit" or "mozilla". teams The teams for which this repo should belong to, specified as a dict of team name to permission ('pull', 'push' or 'admin'). .. versionadded:: 2017.7.0 Example: .. code-block:: yaml Ensure repo my-repo is present in github: github.repo_present: - name: 'my-repo' - description: 'My very important repository' .. versionadded:: 2016.11.0 """ ret = {"name": name, "changes": {}, "result": True, "comment": ""} # This is an optimization to cache all repos in the organization up front. # The first use of this state will collect all of the repos and save a bunch # of API calls for future use. __salt__["github.list_repos"](profile=profile) try: target = __salt__["github.get_repo_info"](name, profile=profile, **kwargs) except CommandExecutionError: target = None given_params = { "description": description, "homepage": homepage, "private": private, "has_issues": has_issues, "has_wiki": has_wiki, "has_downloads": has_downloads, "auto_init": auto_init, "gitignore_template": gitignore_template, "license_template": license_template, } # Keep track of current_teams if we've fetched them after creating a new repo current_teams = None if target: # Repo already exists # Some params are only valid on repo creation ignore_params = ["auto_init", "gitignore_template", "license_template"] parameters = {} old_parameters = {} for param_name, param_value in given_params.items(): if ( param_value is not None and param_name not in ignore_params and target[param_name] is not param_value and target[param_name] != param_value ): parameters[param_name] = param_value old_parameters[param_name] = target[param_name] if len(parameters) > 0: repo_change = { "old": "Repo properties were {}".format(old_parameters), "new": "Repo properties (that changed) are {}".format(parameters), } if __opts__["test"]: ret["changes"]["repo"] = repo_change ret["result"] = None else: result = __salt__["github.edit_repo"]( name, profile=profile, **parameters ) if result: ret["changes"]["repo"] = repo_change else: ret["result"] = False ret["comment"] = "Failed to update repo properties." return ret else: # Repo does not exist - it will be created. repo_change = {"old": None, "new": "Repo {} has been created".format(name)} if __opts__["test"]: ret["changes"]["repo"] = repo_change ret["result"] = None else: add_params = dict(given_params) add_params.update(kwargs) result = __salt__["github.add_repo"](name, **add_params) if not result: ret["result"] = False ret["comment"] = "Failed to create repo {}.".format(name) return ret # Turns out that trying to fetch teams for a new repo can 404 immediately # after repo creation, so this waits until we can fetch teams successfully # before continuing. for attempt in range(3): time.sleep(1) try: current_teams = __salt__["github.get_repo_teams"]( name, profile=profile, **kwargs ) break except CommandExecutionError as e: log.info("Attempt %s to fetch new repo %s failed", attempt, name) if current_teams is None: ret["result"] = False ret["comment"] = "Failed to verify repo {} after creation.".format(name) return ret ret["changes"]["repo"] = repo_change if teams is not None: if __opts__["test"] and not target: # Assume no teams if we're in test mode and the repo doesn't exist current_teams = [] elif current_teams is None: current_teams = __salt__["github.get_repo_teams"](name, profile=profile) current_team_names = {t["name"] for t in current_teams} # First remove any teams that aren't present for team_name in current_team_names: if team_name not in teams: team_change = { "old": "Repo {} is in team {}".format(name, team_name), "new": "Repo {} is not in team {}".format(name, team_name), } if __opts__["test"]: ret["changes"][team_name] = team_change ret["result"] = None else: result = __salt__["github.remove_team_repo"]( name, team_name, profile=profile ) if result: ret["changes"][team_name] = team_change else: ret["result"] = False ret[ "comment" ] = "Failed to remove repo {} from team {}.".format( name, team_name ) return ret # Next add or modify any necessary teams for team_name, permission in teams.items(): if team_name not in current_team_names: # Need to add repo to team team_change = { "old": "Repo {} is not in team {}".format(name, team_name), "new": "Repo {} is in team {}".format(name, team_name), } if __opts__["test"]: ret["changes"][team_name] = team_change ret["result"] = None else: result = __salt__["github.add_team_repo"]( name, team_name, profile=profile, permission=permission ) if result: ret["changes"][team_name] = team_change else: ret["result"] = False ret[ "comment" ] = "Failed to remove repo {} from team {}.".format( name, team_name ) return ret else: current_permission = ( __salt__["github.list_team_repos"](team_name, profile=profile) .get(name.lower(), {}) .get("permission") ) if not current_permission: ret["result"] = False ret["comment"] = ( "Failed to determine current permission for team " "{} in repo {}".format(team_name, name) ) return ret elif current_permission != permission: team_change = { "old": "Repo {} in team {} has permission {}".format( name, team_name, current_permission ), "new": "Repo {} in team {} has permission {}".format( name, team_name, permission ), } if __opts__["test"]: ret["changes"][team_name] = team_change ret["result"] = None else: result = __salt__["github.add_team_repo"]( name, team_name, profile=profile, permission=permission ) if result: ret["changes"][team_name] = team_change else: ret["result"] = False ret["comment"] = ( "Failed to set permission on repo {} from " "team {} to {}.".format(name, team_name, permission) ) return ret return ret def repo_absent(name, profile="github", **kwargs): """ Ensure a repo is absent. Example: .. code-block:: yaml ensure repo test is absent in github: github.repo_absent: - name: 'test' The following parameters are required: name This is the name of the repository in the organization. .. versionadded:: 2016.11.0 """ ret = {"name": name, "changes": {}, "result": None, "comment": ""} try: target = __salt__["github.get_repo_info"](name, profile=profile, **kwargs) except CommandExecutionError: target = None if not target: ret["comment"] = "Repo {} does not exist".format(name) ret["result"] = True return ret else: if __opts__["test"]: ret["comment"] = "Repo {} will be deleted".format(name) ret["result"] = None return ret result = __salt__["github.remove_repo"](name, profile=profile, **kwargs) if result: ret["comment"] = "Deleted repo {}".format(name) ret["changes"].setdefault("old", "Repo {} exists".format(name)) ret["changes"].setdefault("new", "Repo {} deleted".format(name)) ret["result"] = True else: ret["comment"] = ( "Failed to delete repo {}. Ensure the delete_repo " "scope is enabled if using OAuth.".format(name) ) ret["result"] = False return ret
Save