VOL-3349: Software image url documentation and typo corrected
Change-Id: Ibf2567dc4b1b1861c0dddfdb097759f758d4d230
diff --git a/dmi.pb b/dmi.pb
index 2ded355..dca8aad 100644
--- a/dmi.pb
+++ b/dmi.pb
Binary files differ
diff --git a/go/dmi/sw_image.pb.go b/go/dmi/sw_image.pb.go
index e8136f8..04b287d 100644
--- a/go/dmi/sw_image.pb.go
+++ b/go/dmi/sw_image.pb.go
@@ -69,7 +69,7 @@
type ImageStatus_Reason int32
const (
- ImageStatus_UNDEFINED_READON ImageStatus_Reason = 0
+ ImageStatus_UNDEFINED_REASON ImageStatus_Reason = 0
ImageStatus_ERROR_IN_REQUEST ImageStatus_Reason = 1
ImageStatus_INTERNAL_ERROR ImageStatus_Reason = 2
ImageStatus_DEVICE_IN_WRONG_STATE ImageStatus_Reason = 3
@@ -78,7 +78,7 @@
)
var ImageStatus_Reason_name = map[int32]string{
- 0: "UNDEFINED_READON",
+ 0: "UNDEFINED_REASON",
1: "ERROR_IN_REQUEST",
2: "INTERNAL_ERROR",
3: "DEVICE_IN_WRONG_STATE",
@@ -87,7 +87,7 @@
}
var ImageStatus_Reason_value = map[string]int32{
- "UNDEFINED_READON": 0,
+ "UNDEFINED_REASON": 0,
"ERROR_IN_REQUEST": 1,
"INTERNAL_ERROR": 2,
"DEVICE_IN_WRONG_STATE": 3,
@@ -156,6 +156,8 @@
// Script must be included in the object downloaded from the image_url
ImageInstallScript string `protobuf:"bytes,2,opt,name=image_install_script,json=imageInstallScript,proto3" json:"image_install_script,omitempty"`
// Location of the image and installation script, authentication (user/pass) if any should be in the url string
+ // The image_url would contain the protocol, credentials, the IP address/DNS of the server and the path of the file
+ // e.g. sftp://download_user:download_pass@192.168.0.1:22/images/image1
ImageUrl string `protobuf:"bytes,3,opt,name=image_url,json=imageUrl,proto3" json:"image_url,omitempty"`
// SHA-256 sum of the image (sha256sum on Linux)
Sha256Sum string `protobuf:"bytes,5,opt,name=sha256sum,proto3" json:"sha256sum,omitempty"`
@@ -264,7 +266,7 @@
if m != nil {
return m.Reason
}
- return ImageStatus_UNDEFINED_READON
+ return ImageStatus_UNDEFINED_REASON
}
func (m *ImageStatus) GetState() ImageStatus_ImageState {
@@ -295,38 +297,38 @@
// 572 bytes of a gzipped FileDescriptorProto
0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x64, 0x93, 0xcf, 0x6e, 0xd3, 0x4c,
0x14, 0xc5, 0xeb, 0xe6, 0x4f, 0xdb, 0x9b, 0xef, 0x0b, 0xce, 0xb4, 0x55, 0x03, 0x05, 0xa9, 0x0a,
- 0x0b, 0xd8, 0x34, 0x86, 0x54, 0x20, 0x21, 0x56, 0xae, 0x3d, 0x0d, 0x23, 0x92, 0x71, 0x99, 0x38,
+ 0x0b, 0xd8, 0x34, 0x86, 0x54, 0x20, 0x21, 0x56, 0xae, 0x33, 0x0d, 0x23, 0x92, 0x71, 0x19, 0x3b,
0x41, 0xb0, 0xb1, 0x5c, 0x7b, 0x9a, 0x8e, 0x94, 0xb1, 0x2b, 0xdb, 0x29, 0xaf, 0xc1, 0x0b, 0xb0,
0xe7, 0x6d, 0x78, 0x25, 0x34, 0x33, 0x6e, 0x53, 0x89, 0xdd, 0xf8, 0x9c, 0xdf, 0xbd, 0xf7, 0xdc,
0x2b, 0x19, 0x50, 0x2a, 0x85, 0x53, 0xfe, 0x88, 0x84, 0x8c, 0x97, 0x7c, 0x78, 0x5b, 0xe4, 0x55,
- 0x8e, 0x1a, 0xa9, 0x14, 0xcf, 0x7a, 0xca, 0x48, 0x72, 0x29, 0xf3, 0xac, 0x34, 0xfa, 0x60, 0x0c,
+ 0x8e, 0x1a, 0xa9, 0x14, 0xcf, 0x7a, 0xca, 0x48, 0x72, 0x29, 0xf3, 0xac, 0x34, 0xfa, 0x60, 0x02,
0xff, 0x11, 0x85, 0x2d, 0x78, 0x51, 0x8a, 0x3c, 0x43, 0x2f, 0x00, 0x74, 0x59, 0x94, 0xc5, 0x92,
0xf7, 0xad, 0x13, 0xeb, 0xf5, 0x1e, 0xdb, 0xd3, 0x0a, 0x8d, 0x25, 0x47, 0x7d, 0xd8, 0xb9, 0x33,
0x64, 0x7f, 0x5b, 0x7b, 0xf7, 0x9f, 0x83, 0xdf, 0x16, 0xd8, 0xba, 0x13, 0xc9, 0xae, 0xf3, 0x42,
0xc6, 0x95, 0xea, 0xf6, 0x0a, 0x5a, 0xba, 0x56, 0x37, 0xea, 0x8c, 0x7a, 0xc3, 0x54, 0x8a, 0xe1,
0xe3, 0x79, 0xcc, 0xf8, 0xe8, 0x0d, 0x1c, 0x98, 0xb1, 0x22, 0x2b, 0xab, 0x78, 0xb5, 0x8a, 0xca,
- 0xa4, 0x10, 0xb7, 0x55, 0x3d, 0x04, 0x09, 0xd3, 0x58, 0x5b, 0x33, 0xed, 0xa0, 0x63, 0x30, 0xb1,
- 0xa2, 0x75, 0xb1, 0xea, 0x37, 0x34, 0xb6, 0xab, 0x85, 0x79, 0xb1, 0x42, 0xcf, 0x61, 0xaf, 0xbc,
- 0x89, 0x47, 0xef, 0xde, 0x97, 0x6b, 0xd9, 0x6f, 0x99, 0x25, 0x1e, 0x84, 0xc1, 0xaf, 0x26, 0x74,
- 0x74, 0x88, 0x59, 0x15, 0x57, 0xeb, 0x12, 0xbd, 0x84, 0x76, 0xa9, 0x5f, 0x3a, 0x66, 0x77, 0xd4,
- 0xd1, 0x31, 0x8d, 0xc9, 0x6a, 0x0b, 0x39, 0xd0, 0x2e, 0x78, 0x5c, 0xd6, 0x8b, 0x77, 0x47, 0x47,
- 0x9b, 0x5d, 0x0c, 0x39, 0x64, 0xda, 0x66, 0x35, 0x86, 0xde, 0x42, 0x4b, 0x95, 0x72, 0x1d, 0xae,
- 0x3b, 0x3a, 0xfe, 0x87, 0x7f, 0x78, 0x73, 0x66, 0x48, 0x74, 0x02, 0x9d, 0x94, 0x9b, 0xcd, 0xd5,
- 0x85, 0x9b, 0x3a, 0xf8, 0x63, 0x69, 0xf0, 0xc7, 0x02, 0xd8, 0xd4, 0xa1, 0x7d, 0x78, 0x32, 0xa7,
- 0x3e, 0xbe, 0x20, 0x14, 0xfb, 0xd1, 0x2c, 0x74, 0x43, 0x6c, 0x6f, 0xa1, 0x1e, 0xfc, 0xef, 0x05,
- 0x97, 0xdf, 0x08, 0x1d, 0x47, 0x64, 0xea, 0x8e, 0xb1, 0x6d, 0xa1, 0x03, 0xb0, 0x09, 0x9d, 0x85,
- 0xee, 0x64, 0xb2, 0x51, 0xb7, 0x55, 0xb5, 0x17, 0x4c, 0xa7, 0x24, 0xdc, 0x88, 0x0d, 0x85, 0x32,
- 0x7c, 0x1e, 0x04, 0x5a, 0xf4, 0xf1, 0x82, 0x78, 0xd8, 0x6e, 0x2a, 0x75, 0x7e, 0x39, 0x66, 0xae,
- 0x8f, 0x23, 0x2f, 0x98, 0x5e, 0x4e, 0x70, 0x88, 0xed, 0x16, 0x42, 0xd0, 0xbd, 0x57, 0x2f, 0x5c,
- 0x32, 0xc1, 0xbe, 0xdd, 0x46, 0x47, 0xb0, 0xef, 0x7a, 0x21, 0x59, 0xb8, 0x21, 0x09, 0xe8, 0x06,
- 0xde, 0x41, 0x87, 0xd0, 0x7b, 0x64, 0xd4, 0xfc, 0xee, 0xe0, 0xa7, 0x05, 0x6d, 0x73, 0x39, 0x3d,
- 0xe4, 0x61, 0x1b, 0x86, 0x5d, 0x3f, 0xa0, 0xf6, 0x96, 0x52, 0x31, 0x63, 0x01, 0x8b, 0x08, 0x8d,
- 0x18, 0xfe, 0x32, 0xc7, 0xb3, 0xd0, 0xb6, 0xd4, 0x68, 0x42, 0x43, 0xcc, 0xa8, 0x3b, 0x89, 0xb4,
- 0x6d, 0x6f, 0xa3, 0xa7, 0x70, 0x68, 0x02, 0x2b, 0xf4, 0x2b, 0x0b, 0xe8, 0xb8, 0xbe, 0x49, 0x43,
- 0xdd, 0x84, 0xd0, 0x85, 0x3b, 0x21, 0x7e, 0xbd, 0x68, 0x13, 0xf5, 0xe1, 0xc0, 0x30, 0x5a, 0x88,
- 0xbc, 0x4f, 0xd8, 0xfb, 0x3c, 0x9b, 0x4f, 0xed, 0xd6, 0xf9, 0xc7, 0xef, 0x1f, 0x96, 0xa2, 0xba,
+ 0xa4, 0x10, 0xb7, 0x55, 0x3d, 0x04, 0x09, 0xd3, 0x58, 0x5b, 0x81, 0x76, 0xd0, 0x31, 0x98, 0x58,
+ 0xd1, 0xba, 0x58, 0xf5, 0x1b, 0x1a, 0xdb, 0xd5, 0xc2, 0xbc, 0x58, 0xa1, 0xe7, 0xb0, 0x57, 0xde,
+ 0xc4, 0xa3, 0x77, 0xef, 0xcb, 0xb5, 0xec, 0xb7, 0xcc, 0x12, 0x0f, 0xc2, 0xe0, 0x57, 0x13, 0x3a,
+ 0x3a, 0x44, 0x50, 0xc5, 0xd5, 0xba, 0x44, 0x2f, 0xa1, 0x5d, 0xea, 0x97, 0x8e, 0xd9, 0x1d, 0x75,
+ 0x74, 0x4c, 0x63, 0xb2, 0xda, 0x42, 0x0e, 0xb4, 0x0b, 0x1e, 0x97, 0xf5, 0xe2, 0xdd, 0xd1, 0xd1,
+ 0x66, 0x17, 0x43, 0x0e, 0x99, 0xb6, 0x59, 0x8d, 0xa1, 0xb7, 0xd0, 0x52, 0xa5, 0x5c, 0x87, 0xeb,
+ 0x8e, 0x8e, 0xff, 0xe1, 0x1f, 0xde, 0x9c, 0x19, 0x12, 0x9d, 0x40, 0x27, 0xe5, 0x66, 0x73, 0x75,
+ 0xe1, 0xa6, 0x0e, 0xfe, 0x58, 0x1a, 0xfc, 0xb1, 0x00, 0x36, 0x75, 0x68, 0x1f, 0x9e, 0xcc, 0xe9,
+ 0x18, 0x5f, 0x10, 0x8a, 0xc7, 0x51, 0x10, 0xba, 0x21, 0xb6, 0xb7, 0x50, 0x0f, 0xfe, 0xf7, 0xfc,
+ 0xcb, 0x6f, 0x84, 0x4e, 0x22, 0x32, 0x73, 0x27, 0xd8, 0xb6, 0xd0, 0x01, 0xd8, 0x84, 0x06, 0xa1,
+ 0x3b, 0x9d, 0x6e, 0xd4, 0x6d, 0x55, 0xed, 0xf9, 0xb3, 0x19, 0x09, 0x37, 0x62, 0x43, 0xa1, 0x0c,
+ 0x9f, 0xfb, 0xbe, 0x16, 0xc7, 0x78, 0x41, 0x3c, 0x6c, 0x37, 0x95, 0x3a, 0xbf, 0x9c, 0x30, 0x77,
+ 0x8c, 0x23, 0xcf, 0x9f, 0x5d, 0x4e, 0x71, 0x88, 0xed, 0x16, 0x42, 0xd0, 0xbd, 0x57, 0x2f, 0x5c,
+ 0x32, 0xc5, 0x63, 0xbb, 0x8d, 0x8e, 0x60, 0xdf, 0xf5, 0x42, 0xb2, 0x70, 0x43, 0xe2, 0xd3, 0x0d,
+ 0xbc, 0x83, 0x0e, 0xa1, 0xf7, 0xc8, 0xa8, 0xf9, 0xdd, 0xc1, 0x4f, 0x0b, 0xda, 0xe6, 0x72, 0x7a,
+ 0xc8, 0xc3, 0x36, 0x0c, 0xbb, 0x81, 0x4f, 0xed, 0x2d, 0xa5, 0x62, 0xc6, 0x7c, 0x16, 0x11, 0x1a,
+ 0x31, 0xfc, 0x65, 0x8e, 0x83, 0xd0, 0xb6, 0xd4, 0x68, 0x42, 0x43, 0xcc, 0xa8, 0x3b, 0x8d, 0xb4,
+ 0x6d, 0x6f, 0xa3, 0xa7, 0x70, 0x68, 0x02, 0x2b, 0xf4, 0x2b, 0xf3, 0xe9, 0xa4, 0xbe, 0x49, 0x43,
+ 0xdd, 0x84, 0xd0, 0x85, 0x3b, 0x25, 0xe3, 0x7a, 0xd1, 0x26, 0xea, 0xc3, 0x81, 0x61, 0xb4, 0x10,
+ 0x79, 0x9f, 0xb0, 0xf7, 0x39, 0x98, 0xcf, 0xec, 0xd6, 0xf9, 0xc7, 0xef, 0x1f, 0x96, 0xa2, 0xba,
0x59, 0x5f, 0x0d, 0x93, 0x5c, 0x3a, 0xf9, 0x2d, 0xcf, 0x92, 0xbc, 0x48, 0x9d, 0x94, 0xdf, 0x89,
0x84, 0x9f, 0xca, 0x38, 0x8b, 0x97, 0x5c, 0xf2, 0xac, 0x3a, 0x15, 0x59, 0xc5, 0x8b, 0xeb, 0x38,
0xe1, 0xce, 0xdd, 0x99, 0xb3, 0xcc, 0x9d, 0x54, 0x8a, 0xab, 0xb6, 0xfe, 0xaf, 0xce, 0xfe, 0x06,
- 0x00, 0x00, 0xff, 0xff, 0xbe, 0x44, 0x10, 0x9d, 0x85, 0x03, 0x00, 0x00,
+ 0x00, 0x00, 0xff, 0xff, 0x34, 0xd0, 0x41, 0x4a, 0x85, 0x03, 0x00, 0x00,
}
diff --git a/protos/dmi/sw_image.proto b/protos/dmi/sw_image.proto
index e85767e..cb73f32 100644
--- a/protos/dmi/sw_image.proto
+++ b/protos/dmi/sw_image.proto
@@ -18,6 +18,8 @@
// Script must be included in the object downloaded from the image_url
string image_install_script = 2;
// Location of the image and installation script, authentication (user/pass) if any should be in the url string
+ // The image_url would contain the protocol, credentials, the IP address/DNS of the server and the path of the file
+ // e.g. sftp://download_user:download_pass@192.168.0.1:22/images/image1
string image_url = 3;
// SHA-256 sum of the image (sha256sum on Linux)
string sha256sum = 5;
@@ -37,7 +39,7 @@
}
enum Reason {
- UNDEFINED_READON = 0;
+ UNDEFINED_REASON = 0;
ERROR_IN_REQUEST = 1;
INTERNAL_ERROR = 2;
DEVICE_IN_WRONG_STATE = 3;