Freezer Policies

The following is an overview of all available policies in Freezer API. For a sample configuration file, refer to Sample Freezer Policy File.

freezer-api

actions:create
Default:

rule:admin_or_owner

Operations:

  • POST /v2/actions

Scope Types:

  • project

Creates action.

actions:delete
Default:

rule:admin_or_owner

Operations:

  • DELETE /v2/actions/{action_id}

Scope Types:

  • project

Delete action.

actions:get
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/actions/{action_id}

Scope Types:

  • project

Show actions.

actions:get_all
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/actions

Scope Types:

  • project

Lists actions.

actions:update
Default:

rule:admin_or_owner

Operations:

  • PATCH /v2/actions/{action_id}

Scope Types:

  • project

Updates actions.

actions:replace
Default:

rule:admin_or_owner

Operations:

  • PUT /v2/actions/{action_id}

Scope Types:

  • project

Creates/replaces the specified action.

backups:create
Default:

rule:admin_or_owner

Operations:

  • POST /v2/backups

Scope Types:

  • project

Creates backup entry.

backups:delete
Default:

rule:admin_or_owner

Operations:

  • DELETE /v2/backups/{backup_id}

Scope Types:

  • project

Delete backup.

backups:get
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/backups/{backup_id}

Scope Types:

  • project

Show backups.

backups:get_all
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/backups

Scope Types:

  • project

Lists backups.

context_is_admin
Default:

role:admin

Scope Types:

  • project

(no description provided)

admin_or_owner
Default:

is_admin:True or project_id:%(project_id)s

Scope Types:

  • project

(no description provided)

admin_or_service
Default:

role:admin or role:service

Scope Types:

  • project

(no description provided)

project_member
Default:

role:member and project_id:%(project_id)s

Scope Types:

  • project

(no description provided)

project_reader
Default:

role:reader and project_id:%(project_id)s

Scope Types:

  • project

(no description provided)

admin_or_reader_or_service
Default:

rule:admin_or_owner or rule:project_reader or role:service

Scope Types:

  • project

(no description provided)

clients:create
Default:

rule:admin_or_owner

Operations:

  • POST /v2/clients

Scope Types:

  • project

Create client entry.

clients:delete
Default:

rule:admin_or_owner

Operations:

  • DELETE /v2/clients/{client_id}

Scope Types:

  • project

Delete specified client.

clients:get
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/clients/{client_id}

Scope Types:

  • project

Show clients.

clients:get_all
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/clients

Scope Types:

  • project

List clients.

clients:create_central
Default:

rule:admin_or_service

Operations:

  • POST /v2/{project_id}/clients

Scope Types:

  • project

Register a central scheduler client.

jobs:create
Default:

rule:admin_or_owner

Operations:

  • POST /v2/jobs

Scope Types:

  • project

Creates job.

jobs:delete
Default:

rule:admin_or_owner

Operations:

  • DELETE /v2/jobs/{job_id}

Scope Types:

  • project

Delete jobs.

jobs:get
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/jobs/{job_id}

Scope Types:

  • project

Show jobs.

jobs:get_all
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/jobs

Scope Types:

  • project

Lists jobs.

jobs:get_all_projects
Default:

rule:admin_or_service

Operations:

  • GET /v2/jobs

Scope Types:

  • project

Lists all projects jobs.

jobs:update
Default:

rule:admin_or_owner

Operations:

  • PATCH /v2/jobs/{job_id}

Scope Types:

  • project

Updates jobs.

jobs:event:create
Default:

rule:admin_or_owner

Operations:

  • POST /v2/jobs/{job_id}/event

Scope Types:

  • project

Create an event on the specified job

sessions:create
Default:

rule:admin_or_owner

Operations:

  • POST /v2/sessions

Scope Types:

  • project

Creates session.

sessions:delete
Default:

rule:admin_or_owner

Operations:

  • DELETE /v2/sessions/{session_id}

Scope Types:

  • project

Delete session.

sessions:get
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/sessions/{session_id}

Scope Types:

  • project

Show sessions.

sessions:get_all
Default:

rule:admin_or_reader_or_service

Operations:

  • GET /v2/sessions

Scope Types:

  • project

Lists sessions.

sessions:update
Default:

rule:admin_or_owner

Operations:

  • PATCH /v2/sessions/{session_id}

Scope Types:

  • project

Updates sessions.

sessions:replace
Default:

rule:admin_or_owner

Operations:

  • PUT /v2/sessions/{session_id}

Scope Types:

  • project

Creates/replaces the specified session.

sessions:action:create
Default:

rule:admin_or_owner

Operations:

  • POST /v2/sessions/{session_id}/action

Scope Types:

  • project

Executes an action on the specified session.

sessions:job:add
Default:

rule:admin_or_owner

Operations:

  • PUT /v2/sessions/{session_id}/jobs/{job_id}

Scope Types:

  • project

Adds a certain job to a session.

sessions:job:remove
Default:

rule:admin_or_owner

Operations:

  • DELETE /v2/sessions/{session_id}/jobs/{job_id}

Scope Types:

  • project

Remove a job from a session.