Profiles Service

Alpha feature

The configuration profiles feature is in an alpha state, we will be making breaking changes to its API in release 1.12. Please contact Tetrate if you have any questions or concerns.

Profiles

The Profiles service exposes methods to manage the profiles that exist in TSB.

CreateProfile

GetProfile

UpdateProfile

ListProfiles

ListAvailableProfiles

DeleteProfile

Blame

BlameRequest

Request to gather profile blame data for a given resource.

Field	Description	Validation Rule
fqn	string REQUIRED fqn of the source to get the profile troubleshoting data for.	string = {   min_len: 1 }

BlameResponse

Blame data for a given resource. Example:

effectiveProfileConfig:
  trafficSettings:
    reachability:
      mode: GROUP
    resilience:
      circuitBreakerSensitivity: MEDIUM
  authenticationSettings:
    trafficMode: REQUIRED
effectiveProfilePaths:
  authenticationSettings: organizations/my-org/profiles/profile1
  authenticationSettings.trafficMode: organizations/my-org/profiles/profile1
  trafficSettings: organizations/my-org/tenants/my-tenant/workspaces/ws/trafficgroups/tg/profiles/profile2
  trafficSettings.reachability: organizations/my-org/tenants/my-tenant/workspaces/ws/trafficgroups/tg/profiles/profile2
  trafficSettings.reachability.mode: organizations/my-org/tenants/my-tenant/workspaces/ws/trafficgroups/tg/profiles/profile2
  trafficSettings.resilience: organizations/my-org/tenants/my-tenant/workspaces/ws/trafficgroups/tg/profiles/profile2
  trafficSettings.resilience.circuitBreakerSensitivity: organizations/my-org/tenants/my-tenant/workspaces/ws/trafficgroups/tg/profiles/profile2

Field	Description	Validation Rule
effectiveProfileConfig	tetrateio.api.tsb.profile.v2.ProfileConfig The resolved profile computed from all the attached profiles to the resource.	–
effectiveProfilePaths	map<string, string> Map of profile config field paths to the resource FQNs that set the value at that path.	–
effectiveProfileMandatedPaths	List of string Subset of the previous map keys (paths) which values are set by mandates.	–

CreateProfileRequest

Request to create a profile belonging to a given resource.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource where the Profile will be created.	string = {   min_len: 1 }
name	string REQUIRED The short name for the resource to be created.	string = {   min_len: 1   max_len: 63   pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ }
profile	tetrateio.api.tsb.profile.v2.Profile REQUIRED Details of the profile to be created.	message = {   required: true }

DeleteProfileRequest

Request to delete a specific profile belonging to a given resource.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the profile.	string = {   min_len: 1 }
force	bool Force the deletion of the object even if deletion protection is enabled.	–

GetProfileRequest

Request to retrieve a profile belonging to a given resource.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the profile.	string = {   min_len: 1 }

ListAvailableProfilesRequest

Request to list available profiles that can be attached to a given resource.

Field	Description	Validation Rule
fqn	string REQUIRED Resource fqn where the Profiles can be attached.	string = {   min_len: 1 }

ListAvailableProfilesResponse

List of profiles that can be attached to a given resource.

Field	Description	Validation Rule
profiles	List of tetrateio.api.tsb.profile.v2.Profile List of profiles.	–

ListProfilesRequest

Request to list profiles belonging to a given resource.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource where the Profiles to list are created.	string = {   min_len: 1 }

ListProfilesResponse

List of profiles belonging to a given resource.

Field	Description	Validation Rule
profiles	List of tetrateio.api.tsb.profile.v2.Profile List of profiles.	–