gcp

package
v1.0.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Defines a Policy type which wraps the iam.Policy object. This enables callers of the gcp package to process iam policies without needing to make additional imports.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FmtDnsName added in v1.0.12

func FmtDnsName(domainPrefix, baseDomain string) string

func FmtDnsZoneName added in v1.0.12

func FmtDnsZoneName(domainPrefix, baseDomain string) string

func FmtNetworkResourceId added in v1.0.12

func FmtNetworkResourceId(projectId, networkId string) string

func FmtSaResourceId added in v1.0.4

func FmtSaResourceId(accountId, projectId string) string

func GenerateCreateBashScript added in v1.0.17

func GenerateCreateBashScript(fr *FirewallRuleset) string

GenerateCreateBashScript generates a bash script with all firewall rule commands Used for manual mode, where the commands are not called during runtime

func GenerateDeleteBashScript added in v1.0.17

func GenerateDeleteBashScript(fr *FirewallRuleset) string

GenerateDeleteBashScript generates a bash script with all firewall rule commands Used for manual mode, where the commands are not called during runtime

func GenerateUpdateBashScript added in v1.0.17

func GenerateUpdateBashScript(fr *FirewallRuleset) string

GenerateUpdateBashScript generates a bash script with all firewall rule update commands Used for manual mode, where the commands ensure the firewall rules match the intended configuration

Types

type FirewallRuleset added in v1.0.17

type FirewallRuleset struct {
	*cmv1.GcpFirewallRule
}

func NewFirewallRuleset added in v1.0.17

func NewFirewallRuleset(ruleset *cmv1.GcpFirewallRule) *FirewallRuleset

type GcpClient

type GcpClient interface {
	CreateRole(context.Context, *adminpb.CreateRoleRequest) (*adminpb.Role, error)
	CreateServiceAccount(ctx context.Context, request *adminpb.CreateServiceAccountRequest) (*adminpb.ServiceAccount, error)
	CreateWorkloadIdentityPool(ctx context.Context, parent, poolID string, pool *iamv1.WorkloadIdentityPool) (*iamv1.Operation, error)
	CreateWorkloadIdentityProvider(ctx context.Context, parent, providerID string, provider *iamv1.WorkloadIdentityPoolProvider) (*iamv1.Operation, error)
	DeleteServiceAccount(ctx context.Context, saName string, project string, allowMissing bool) error
	DeleteWorkloadIdentityPool(ctx context.Context, resource string) (*iamv1.Operation, error)
	EnableServiceAccount(ctx context.Context, serviceAccountId string, projectId string) error
	EnableWorkloadIdentityPool(ctx context.Context, poolId string) error
	GetProjectIamPolicy(ctx context.Context, projectName string, request *cloudresourcemanager.GetIamPolicyRequest) (*cloudresourcemanager.Policy, error)
	GetRole(context.Context, *adminpb.GetRoleRequest) (*adminpb.Role, error)
	GetServiceAccount(ctx context.Context, request *adminpb.GetServiceAccountRequest) (*adminpb.ServiceAccount, error)
	GetServiceAccountAccessPolicy(ctx context.Context, saId string) (Policy, error)
	GetWorkloadIdentityPool(ctx context.Context, resource string) (*iamv1.WorkloadIdentityPool, error)
	GetWorkloadIdentityProvider(ctx context.Context, resource string) (*iamv1.WorkloadIdentityPoolProvider, error)
	ProjectNumberFromId(ctx context.Context, projectId string) (int64, error)
	SetProjectIamPolicy(ctx context.Context, svcAcctResource string, request *cloudresourcemanager.SetIamPolicyRequest) (*cloudresourcemanager.Policy, error)
	SetServiceAccountAccessPolicy(ctx context.Context, policy Policy) error
	UndeleteRole(context.Context, *adminpb.UndeleteRoleRequest) (*adminpb.Role, error)
	UndeleteWorkloadIdentityPool(ctx context.Context, resource string, request *iamv1.UndeleteWorkloadIdentityPoolRequest) (*iamv1.Operation, error)
	UpdateRole(context.Context, *adminpb.UpdateRoleRequest) (*adminpb.Role, error)
	UpdateWorkloadIdentityPoolOidcIdentityProvider(ctx context.Context, provider *iamv1.WorkloadIdentityPoolProvider) error
	CreateDnsZone(ctx context.Context, dnsDomain *cmv1.DNSDomain, hostProjectId string) (*dns.ManagedZone, error)
	DeleteDnsZone(ctx context.Context, dnsDomain *cmv1.DNSDomain) error
	GetDnsZone(ctx context.Context, dnsZone *cmv1.DNSDomain) (*dns.ManagedZone, error)
}

func NewGcpClient

func NewGcpClient(ctx context.Context) (GcpClient, error)

type Policy added in v1.0.4

type Policy interface {
	HasRole(member PolicyMember, roleName RoleName) bool
	AddRole(member PolicyMember, roleName RoleName)
	RemoveRole(member PolicyMember, roleName RoleName)

	// Getters
	IamPolicy() *iam.Policy
	ResourceId() string
}

type PolicyMember added in v1.0.4

type PolicyMember string

The resource name belonging to the policy.

For service accounts, this would take the forms: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}`

It is recommended that wildcard `-` form is avoided due to the potential for misleading error messages. The client helper FmtSaResourceId produces a string that may be used as a policy member.

type RoleName added in v1.0.4

type RoleName string

The name of the role belonging to the policy.

Values of this type take two different forms, depending on whether it is predefined.

For predefined roles: * `roles/{role_id}`

For custom roles: * `projects/{project}/roles/{role_id}`

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL