Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
343 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| mdata-* | ||
| proto/ | ||
| /mdata-* | ||
| /proto/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| .\" Copyright (c) 2013, Joyent, Inc. All rights reserved. | ||
|
|
||
| .TH "MDATA-DELETE" "1M" "October 2013" "Joyent SmartDataCenter" "Metadata Commands" | ||
|
|
||
| .SH "NAME" | ||
| \fBmdata-delete\fR \-\- Delete a metadata key-value pair\. | ||
|
|
||
| .SH "SYNOPSIS" | ||
| . | ||
| .nf | ||
| \fB/usr/sbin/mdata-delete\fR \fIkeyname\fR | ||
| .fi | ||
|
|
||
| .SH "DESCRIPTION" | ||
| .sp | ||
| .LP | ||
| The \fBmdata-delete\fR command allows the user (or a script) to modify the | ||
| metadata for a guest instance running in a \fISmartDataCenter (SDC)\fR cloud. | ||
| Metadata values are generally set programmatically via \fICloudAPI\fR, or | ||
| during interactive provisioning via a Web Portal. They may also be set from | ||
| within the instance with the \fBmdata-put\fR command. | ||
| .sp | ||
| .LP | ||
| The key-value pair for \fIkeyname\fR will be removed permanently from the | ||
| metadata stored for this guest instance. Deletion of a key which did not | ||
| exist is not considered an error. | ||
| .sp | ||
| .LP | ||
| If the metadata service is unavailable at the time of the request, this command | ||
| will block waiting for it to become available. Non-transient failures will | ||
| cause the program to exit with a non-zero status. Depending on the nature of | ||
| the error, some diagnostic output may be printed to \fBstderr\fR. | ||
|
|
||
| .SH "EXIT STATUS" | ||
| .sp | ||
| .LP | ||
| The following exit values are returned: | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB0\fR | ||
| .ad | ||
| .RS 5n | ||
| Successful completion. | ||
| .sp | ||
| The key-value pair named \fIkeyname\fR was removed from the instance metadata, | ||
| or did not initially exist. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB2\fR | ||
| .ad | ||
| .RS 5n | ||
| An error occurred. | ||
| .sp | ||
| An unexpected error condition occurred, which is believed to be a | ||
| non-transient condition. Retrying the request is not expected to | ||
| resolve the error condition; either a software bug or misconfiguration | ||
| exists. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB3\fR | ||
| .ad | ||
| .RS 5n | ||
| A usage error occurred. | ||
| .sp | ||
| Malformed arguments were passed to the program. Check the usage instructions | ||
| to ensure valid arguments are supplied. | ||
| .RE | ||
|
|
||
| .SH "SEE ALSO" | ||
| .sp | ||
| .LP | ||
| \fBmdata-get\fR(1M), \fBmdata-list\fR(1M), \fBmdata-put\fR(1M) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| .\" Copyright (c) 2013, Joyent, Inc. All rights reserved. | ||
|
|
||
| .TH "MDATA-GET" "1M" "October 2013" "Joyent SmartDataCenter" "Metadata Commands" | ||
|
|
||
| .SH "NAME" | ||
| \fBmdata-get\fR \-\- Fetch the value of a metadata key-value pair\. | ||
|
|
||
| .SH "SYNOPSIS" | ||
| . | ||
| .nf | ||
| \fB/usr/sbin/mdata-get\fR \fIkeyname\fR | ||
| .fi | ||
|
|
||
| .SH "DESCRIPTION" | ||
| .sp | ||
| .LP | ||
| The \fBmdata-get\fR command allows the user (or a script) to query the metadata | ||
| for a guest instance running in a \fISmartDataCenter (SDC)\fR cloud. Metadata | ||
| values are generally set programmatically via \fICloudAPI\fR, or during | ||
| interactive provisioning via a Web Portal. They may also be set from within | ||
| the instance with the \fBmdata-put\fR command. | ||
| .sp | ||
| .LP | ||
| The value of the requested \fIkeyname\fR will be printed to \fBstdout\fR. If | ||
| the metadata service is unavailable at the time of the request, this command | ||
| will block waiting for it to become available. Non-transient failures, such | ||
| as the non-existence of the requested \fIkeyname\fR, will cause the program | ||
| to exit with a non-zero status. Depending on the nature of the error, some | ||
| diagnostic output may be printed to \fBstderr\fR. | ||
|
|
||
| .SH "EXIT STATUS" | ||
| .sp | ||
| .LP | ||
| The following exit values are returned: | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB0\fR | ||
| .ad | ||
| .RS 5n | ||
| Successful completion. | ||
| .sp | ||
| The requested \fIkeyname\fR was available, and its value was emitted to | ||
| \fBstdout\fR. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB1\fR | ||
| .ad | ||
| .RS 5n | ||
| Metadata value not found. | ||
| .sp | ||
| The requested \fIkeyname\fR was not found in the metadata. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB2\fR | ||
| .ad | ||
| .RS 5n | ||
| An error occurred. | ||
| .sp | ||
| An unexpected error condition occurred, which is believed to be a | ||
| non-transient condition. Retrying the request is not expected to | ||
| resolve the error condition; either a software bug or misconfiguration | ||
| exists. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB3\fR | ||
| .ad | ||
| .RS 5n | ||
| A usage error occurred. | ||
| .sp | ||
| Malformed arguments were passed to the program. Check the usage instructions | ||
| to ensure valid arguments are supplied. | ||
| .RE | ||
|
|
||
| .SH "SEE ALSO" | ||
| .sp | ||
| .LP | ||
| \fBmdata-delete\fR(1M), \fBmdata-list\fR(1M), \fBmdata-put\fR(1M) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| .\" Copyright (c) 2013, Joyent, Inc. All rights reserved. | ||
|
|
||
| .TH "MDATA-LIST" "1M" "October 2013" "Joyent SmartDataCenter" "Metadata Commands" | ||
|
|
||
| .SH "NAME" | ||
| \fBmdata-list\fR \-\- Fetch the list of available metadata key-value pairs\. | ||
|
|
||
| .SH "SYNOPSIS" | ||
| . | ||
| .nf | ||
| \fB/usr/sbin/mdata-list\fR | ||
| .fi | ||
|
|
||
| .SH "DESCRIPTION" | ||
| .sp | ||
| .LP | ||
| The \fBmdata-list\fR command allows the user (or a script) to query the metadata | ||
| for a guest instance running in a \fISmartDataCenter (SDC)\fR cloud. Metadata | ||
| values are generally set programmatically via \fICloudAPI\fR, or during | ||
| interactive provisioning via a Web Portal. They may also be set from within | ||
| the instance with the \fBmdata-put\fR command. The value of a key-value pair | ||
| may be obtained by passing its name to the \fBmdata-get\fR command. | ||
| .sp | ||
| .LP | ||
| The list of all customer-provided metadata key-value pairs will be printed to | ||
| \fBstdout\fR. If the metadata service is unavailable at the time of the | ||
| request, this command will block waiting for it to become available. | ||
| Non-transient failures will cause the program to exit with a non-zero status. | ||
| Depending on the nature of the error, some diagnostic output may be printed to | ||
| \fBstderr\fR. | ||
|
|
||
| .SH "EXIT STATUS" | ||
| .sp | ||
| .LP | ||
| The following exit values are returned: | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB0\fR | ||
| .ad | ||
| .RS 5n | ||
| Successful completion. | ||
| .sp | ||
| The list of key-value pairs was emitted to \fBstdout\fR. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB2\fR | ||
| .ad | ||
| .RS 5n | ||
| An error occurred. | ||
| .sp | ||
| An unexpected error condition occurred, which is believed to be a | ||
| non-transient condition. Retrying the request is not expected to | ||
| resolve the error condition; either a software bug or misconfiguration | ||
| exists. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB3\fR | ||
| .ad | ||
| .RS 5n | ||
| A usage error occurred. | ||
| .sp | ||
| Malformed arguments were passed to the program. Check the usage instructions | ||
| to ensure valid arguments are supplied. | ||
| .RE | ||
|
|
||
| .SH "SEE ALSO" | ||
| .sp | ||
| .LP | ||
| \fBmdata-delete\fR(1M), \fBmdata-get\fR(1M), \fBmdata-put\fR(1M) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| .\" Copyright (c) 2013, Joyent, Inc. All rights reserved. | ||
|
|
||
| .TH "MDATA-PUT" "1M" "October 2013" "Joyent SmartDataCenter" "Metadata Commands" | ||
|
|
||
| .SH "NAME" | ||
| \fBmdata-put\fR \-\- Set the value of a metadata key-value pair\. | ||
|
|
||
| .SH "SYNOPSIS" | ||
| . | ||
| .nf | ||
| \fB/usr/sbin/mdata-put\fR \fIkeyname\fR [ \fIvalue\fR ] | ||
| .fi | ||
|
|
||
| .SH "DESCRIPTION" | ||
| .sp | ||
| .LP | ||
| The \fBmdata-put\fR command allows the user (or a script) to modify the metadata | ||
| for a guest instance running in a \fISmartDataCenter (SDC)\fR cloud. Metadata | ||
| values are generally set programmatically via \fICloudAPI\fR, or during | ||
| interactive provisioning via a Web Portal. The value of a key-value pair | ||
| may be obtained by passing its name to the \fBmdata-get\fR command. | ||
| .sp | ||
| .LP | ||
| The key-value pair named \fIkeyname\fR will be updated in the metadata store | ||
| for this instance. If a \fIvalue\fR argument is provided on the command-line, | ||
| then that value will be used. Otherwise, if \fIstdin\fR is not a tty, the | ||
| value will be read from \fIstdin\fR. | ||
| .sp | ||
| .LP | ||
| If the metadata service is unavailable at the time of the request, this command | ||
| will block waiting for it to become available. Non-transient failures, such as | ||
| the non-existence of the requested \fIkeyname\fR, will cause the program to | ||
| exit with a non-zero status. Depending on the nature of the error, some | ||
| diagnostic output may be printed to \fBstderr\fR. | ||
|
|
||
| .SH "EXIT STATUS" | ||
| .sp | ||
| .LP | ||
| The following exit values are returned: | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB0\fR | ||
| .ad | ||
| .RS 5n | ||
| Successful completion. | ||
| .sp | ||
| The requested \fIkeyname\fR was valid, and its value was updated. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB2\fR | ||
| .ad | ||
| .RS 5n | ||
| An error occurred. | ||
| .sp | ||
| An unexpected error condition occurred, which is believed to be a | ||
| non-transient condition. Retrying the request is not expected to | ||
| resolve the error condition; either a software bug or misconfiguration | ||
| exists. | ||
| .RE | ||
|
|
||
| .sp | ||
| .ne 2 | ||
| .na | ||
| \fB3\fR | ||
| .ad | ||
| .RS 5n | ||
| A usage error occurred. | ||
| .sp | ||
| Malformed arguments were passed to the program. Check the usage instructions | ||
| to ensure valid arguments are supplied. | ||
| .RE | ||
|
|
||
| .SH "SEE ALSO" | ||
| .sp | ||
| .LP | ||
| \fBmdata-delete\fR(1M), \fBmdata-get\fR(1M), \fBmdata-list\fR(1M) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters