github.com/turtlemonvh/terraform@v0.6.9-0.20151204001754-8e40b6b855e8/website/source/docs/providers/rundeck/r/public_key.html.md (about)

     1  ---
     2  layout: "rundeck"
     3  page_title: "Rundeck: rundeck_public_key"
     4  sidebar_current: "docs-rundeck-resource-public-key"
     5  description: |-
     6    The rundeck_public_key resource allows public keys to be stored in Rundeck's key store.
     7  ---
     8  
     9  # rundeck\_public\_key
    10  
    11  The public key resource allows SSH public keys to be stored into Rundeck's key store.
    12  The key store is where Rundeck keeps credentials that are needed to access the nodes on which
    13  it runs commands.
    14  
    15  This resource also allows the retrieval of an existing public key from the store, so that it
    16  may be used in the configuration of other resources such as ``aws_key_pair``.
    17  
    18  ## Example Usage
    19  
    20  ```
    21  resource "rundeck_public_key" "anvils" {
    22      path = "anvils/id_rsa.pub"
    23      key_material = "ssh-rsa yada-yada-yada"
    24  }
    25  ```
    26  
    27  ## Argument Reference
    28  
    29  The following arguments are supported:
    30  
    31  * `path` - (Required) The path within the key store where the key will be stored. By convention
    32    this path name normally ends with ".pub" and otherwise has the same name as the associated
    33    private key.
    34  
    35  * `key_material` - (Optional) The public key string to store, serialized in any way that is accepted
    36    by OpenSSH. If this is not included, ``key_material`` becomes an attribute that can be used
    37    to read the already-existing key material in the Rundeck store.
    38  
    39  The key material is included inline as a string, which is consistent with the way a public key
    40  is provided to the `aws_key_pair`, `cloudstack_ssh_keypair`, `digitalocean_ssh_key` and
    41  `openstack_compute_keypair_v2` resources. This means the `key_material` argument can be populated
    42  from the interpolation of the `public_key` attribute of such a keypair resource, or vice-versa.
    43  
    44  ## Attributes Reference
    45  
    46  The following attributes are exported:
    47  
    48  * `url` - The URL at which the key material can be retrieved from the key store by other clients.
    49  
    50  * `key_material` - If `key_material` is omitted in the configuration, it becomes an attribute that
    51    exposes the key material already stored at the given `path`.