Skip to main content

GitopsSource

Resource GitopsSource in pulumi-portainer.
3 min read

Resource GitopsSource in pulumi-portainer.

Pulumi type: portainer:index/gitopsSource:GitopsSource.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
administratorsOnlybooleannoWhether the source is restricted to administrators. Only honoured at creation time; Portainer's update API does not carry this field.
gitopsSourceIdstringno
intervalstringnoPolling interval for the repository as a Go duration string (for example 5m). Leave unset to keep Portainer's default.
namestringnoName of the GitOps source as displayed in Portainer. Portainer derives one from the repository URL when this is not set.
passwordstringnoPassword or personal access token paired with username. Portainer never returns it, so it is kept from configuration and cannot detect drift.
publicbooleannoWhether every user can use this source. Changing it is applied through the source's access-control endpoint.
teamAccessesnumber[]noIDs of teams granted access to the source. Applied through the source's access-control endpoint.
tlsSkipVerifybooleannoWhether to skip TLS certificate verification when contacting the Git repository.
urlstringyesURL of the Git repository the source syncs from.
userAccessesnumber[]noIDs of users granted access to the source. Applied through the source's access-control endpoint.
usernamestringnoUsername used to authenticate against the Git repository. Leave unset for a public repository.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
administratorsOnlybooleannoWhether the source is restricted to administrators. Only honoured at creation time; Portainer's update API does not carry this field.
gitopsSourceIdstringno
intervalstringnoPolling interval for the repository as a Go duration string (for example 5m). Leave unset to keep Portainer's default.
lastSyncnumberyesUnix timestamp of the last successful synchronisation, zero when the source has never synced.
namestringnoName of the GitOps source as displayed in Portainer. Portainer derives one from the repository URL when this is not set.
passwordstringnoPassword or personal access token paired with username. Portainer never returns it, so it is kept from configuration and cannot detect drift.
publicbooleannoWhether every user can use this source. Changing it is applied through the source's access-control endpoint.
statusstringyesSync status of the source: healthy, syncing, error, paused or unknown.
statusErrorstringyesError reported by the last synchronisation attempt, empty while the source is healthy.
teamAccessesnumber[]noIDs of teams granted access to the source. Applied through the source's access-control endpoint.
tlsSkipVerifybooleannoWhether to skip TLS certificate verification when contacting the Git repository.
typestringyesSource type reported by Portainer: git, helm or oci. This resource always creates a git source.
urlstringnoURL of the Git repository the source syncs from.
userAccessesnumber[]noIDs of users granted access to the source. Applied through the source's access-control endpoint.
usernamestringnoUsername used to authenticate against the Git repository. Leave unset for a public repository.