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

ImpactAnalysis

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
effectiveProfileMandatedPaths:
  - authenticationSettings
  - authenticationSettings.trafficMode

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 effective paths which values are set by mandates.	–
effectiveProfileAttachmentPaths	map<string, string> Like effective_profile_paths, but the FQNs are from the resources that attach the profiles.	–

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.	–

ExistingProfile

ExistingProfile represents a request to analyze the impact of an existing profile.

Field	Description	Validation Rule
fqn	string REQUIRED The fully-qualified name (FQN) of the profile impact is being analyzed.	string = {   min_len: 1 }

ExistingResource

ExistingResource represents a request to analyze the impact of the attached profiles of a resource.

Field	Description	Validation Rule
fqn	string REQUIRED The fully-qualified name (FQN) of the resource to which profiles are attached. This is used to identify the resource whose attached profiles will be analyzed for impact.	string = {   min_len: 1 }

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 }

Impact

Impact represents a single impact on a field. It specifies how a profile affects a field and the type of the impact (e.g., effective or overridden).

Field	Description	Validation Rule
fieldPath	string The path to the field that is impacted by the profile. This path uniquely identifies the field within the resource.	–
type	tetrateio.api.tsb.profile.v2.Impact.ImpactType The type of the impact. This defines whether the profile's impact on the field is effective or overridden by other configurations.	–

ImpactAnalysis

ImpactAnalysis represents the impact of a profile on a resource.

Field	Description	Validation Rule
effectiveImpactsCount	int32 The number of effective impacts, which refers to the number of fields that are directly impacted by the profile being analyzed.	–
overriddenImpactsCount	int32 The number of overridden impacts, which refers to fields that have been impacted by another configuration, such as another profile or settings like organization default setting, tenant default settings, workspace default settings, traffic settings, etc.	–
impacts	List of tetrateio.api.tsb.profile.v2.Impact The list of individual impacts that were detected during the analysis. Each impact corresponds to a field that is affected by the profile.	–

ImpactAnalysisRequest

ImpactAnalysisRequest is used to request the analysis of different types of impacts on profiles or resources. Only one of the fields should be set at a time, as the request can only analyze one type of impact per request. This ensures clarity in the request scope.

Field	Description	Validation Rule
existingProfile	tetrateio.api.tsb.profile.v2.ExistingProfile Request to analyze the impact of an existing profile, identified by its FQN.	–
modifyProfile	tetrateio.api.tsb.profile.v2.ModifyProfile Request to analyze the impact of modifying an existing profile.	–
existingResource	tetrateio.api.tsb.profile.v2.ExistingResource Request to analyze the impact of an existing resource. The FQN should refer to the resource whose attached profiles are being analyzed for impact.	–
modifyAttachedProfiles	tetrateio.api.tsb.profile.v2.ModifyAttachedProfiles Request to analyze the impact of modifying the attached profiles of a resource.	–
fieldPaths	List of string OPTIONAL List of field paths to analyze the impact of the profiles on. If this field is set, the request will analyze the impact of the profiles only on the specified field paths.	–

ImpactAnalysisResponse

ImpactAnalysisResponse represents the response to the ImpactAnalysisRequest. It contains detailed information about the impacts of the analyzed profiles.

Field	Description	Validation Rule
fqn	string The fully-qualified name (FQN) of the resource impacted.	–
current	tetrateio.api.tsb.profile.v2.ImpactAnalysis The impact analysis of the profile on the resource.	–
modified	tetrateio.api.tsb.profile.v2.ImpactAnalysis The impact analysis of the modified profile on the resource. This field is only set if the request was for a modified profile or modified attached profiles or a resource.	–

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.	–

ModifyAttachedProfiles

ModifyAttachedProfiles represents a request to analyze the impact of modifying the attached profiles of a resource.

Field	Description	Validation Rule
fqn	string REQUIRED The fully-qualified name (FQN) of the resource to which profiles are attached.	string = {   min_len: 1 }
profiles	List of string A list of profiles attached to the resource that will be analyzed for impact. These profiles are used to propagate default and mandatory configurations to child resources, and any changes to them will be reflected in the impact analysis.	–

ModifyProfile

ModifyProfile represents a request to analyze the impact of modifying a profile.

Field	Description	Validation Rule
fqn	string REQUIRED The fully-qualified name (FQN) of the profile to analyze. This should refer to a specific profile in the system.	string = {   min_len: 1 }
profile	tetrateio.api.tsb.profile.v2.Profile REQUIRED The updated profile configuration. This contains the profile that will be modified, and its changes will be analyzed for impact.	–

ImpactType

Enum representing the different types of impact a profile can have on a field.

Field	Number	Description
UNKNOWN	0	The impact type is unknown or unspecified.
EFFECTIVE	1	The profile is effective on the field, meaning the profile directly sets the field's value.
OVERRIDE	2	The field's value is overridden by another profile or configuration, but was previously set by the profile being analyzed.