1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
---
layout: default
built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33
title: 'Resource Type: filebucket'
canonical: "/puppet/latest/types/filebucket.html"
---
# Resource Type: filebucket
> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700
## filebucket
* [Attributes](#filebucket-attributes)
### Description {#filebucket-description}
A repository for storing and retrieving file content by cryptographic checksum. Can
be local to each agent node, or centralized on a primary Puppet server. All
puppet servers provide a filebucket service that agent nodes can access
via HTTP, but you must declare a filebucket resource before any agents
will do so.
Filebuckets are used for the following features:
- **Content backups.** If the `file` type's `backup` attribute is set to
the name of a filebucket, Puppet will back up the _old_ content whenever
it rewrites a file; see the documentation for the `file` type for more
details. These backups can be used for manual recovery of content, but
are more commonly used to display changes and differences in a tool like
Puppet Dashboard.
To use a central filebucket for backups, you will usually want to declare
a filebucket resource and a resource default for the `backup` attribute
in site.pp:
# /etc/puppetlabs/puppet/manifests/site.pp
filebucket { 'main':
path => false, # This is required for remote filebuckets.
server => 'puppet.example.com', # Optional; defaults to the configured primary server.
}
File { backup => main, }
Puppet Servers automatically provide the filebucket service, so
this will work in a default configuration. If you have a heavily
restricted Puppet Server `auth.conf` file, you may need to allow access to the
`file_bucket_file` endpoint.
### Attributes {#filebucket-attributes}
<pre><code>filebucket { 'resource title':
<a href="#filebucket-attribute-name">name</a> => <em># <strong>(namevar)</strong> The name of the...</em>
<a href="#filebucket-attribute-path">path</a> => <em># The path to the _local_ filebucket; defaults to...</em>
<a href="#filebucket-attribute-port">port</a> => <em># The port on which the remote server is...</em>
<a href="#filebucket-attribute-server">server</a> => <em># The server providing the remote filebucket...</em>
# ...plus any applicable <a href="https://puppet.com/docs/puppet/latest/metaparameter.html">metaparameters</a>.
}</code></pre>
#### name {#filebucket-attribute-name}
_(**Namevar:** If omitted, this attribute's value defaults to the resource's title.)_
The name of the filebucket.
([↑ Back to filebucket attributes](#filebucket-attributes))
#### path {#filebucket-attribute-path}
The path to the _local_ filebucket; defaults to the value of the
`clientbucketdir` setting. To use a remote filebucket, you _must_ set
this attribute to `false`.
([↑ Back to filebucket attributes](#filebucket-attributes))
#### port {#filebucket-attribute-port}
The port on which the remote server is listening.
This setting is _only_ consulted if the `path` attribute is set to `false`.
If this attribute is not specified, the first entry in the `server_list`
configuration setting is used, followed by the value of the `serverport`
setting if `server_list` is not set.
([↑ Back to filebucket attributes](#filebucket-attributes))
#### server {#filebucket-attribute-server}
The server providing the remote filebucket service.
This setting is _only_ consulted if the `path` attribute is set to `false`.
If this attribute is not specified, the first entry in the `server_list`
configuration setting is used, followed by the value of the `server` setting
if `server_list` is not set.
([↑ Back to filebucket attributes](#filebucket-attributes))
|
