-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add GCE fingerprinting functionality #215
Merged
Merged
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
9faa553
Fingerprinting code for GCE nodes
dimfeld 444d6f6
isAWS should return false on GCE
dimfeld 458adfa
Use a constant for the default GCE metadata URL
dimfeld 69ec26e
And add a comment to the constant.
dimfeld 983e851
Consolidate GCEMetadataClient into EnvGCEFingerprint
dimfeld a55bdd3
NonXXX tests should pass when actually running in their respective en…
dimfeld f985ef4
TestNetworkFingerprint_notAWS passes even when actually on AWS
dimfeld 79531fe
Compact tags and attribute reading code.
dimfeld a95cedb
Parse information for all GCE network interface.
dimfeld 6acdd9d
Add a few more GCE-specific attributes:
dimfeld 203906b
GCE fingerprinter no longer updates network resources
dimfeld c43978b
Fix old comments and other syntax cleanup
dimfeld 263c5f5
More syntax cleanup
dimfeld File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,231 @@ | ||
package fingerprint | ||
|
||
import ( | ||
"encoding/json" | ||
"io/ioutil" | ||
"log" | ||
"net/http" | ||
"net/url" | ||
"os" | ||
"regexp" | ||
"strings" | ||
"time" | ||
|
||
"github.com/hashicorp/nomad/client/config" | ||
"github.com/hashicorp/nomad/nomad/structs" | ||
) | ||
|
||
// This is where the GCE metadata server normally resides. We hardcode the | ||
// "instance" path as well since it's the only one we access here. | ||
const DEFAULT_GCE_URL = "http://169.254.169.254/computeMetadata/v1/instance/" | ||
|
||
type GCEMetadataClient struct { | ||
} | ||
|
||
type ReqError struct { | ||
StatusCode int | ||
} | ||
|
||
func (e ReqError) Error() string { | ||
return http.StatusText(e.StatusCode) | ||
} | ||
|
||
// EnvGCEFingerprint is used to fingerprint the CPU | ||
type EnvGCEFingerprint struct { | ||
client *http.Client | ||
logger *log.Logger | ||
metadataURL string | ||
} | ||
|
||
// NewEnvGCEFingerprint is used to create a CPU fingerprint | ||
func NewEnvGCEFingerprint(logger *log.Logger) Fingerprint { | ||
// Read the internal metadata URL from the environment, allowing test files to | ||
// provide their own | ||
metadataURL := os.Getenv("GCE_ENV_URL") | ||
if metadataURL == "" { | ||
metadataURL = DEFAULT_GCE_URL | ||
} | ||
|
||
// assume 2 seconds is enough time for inside GCE network | ||
client := &http.Client{ | ||
Timeout: 2 * time.Second, | ||
} | ||
|
||
return &EnvGCEFingerprint{ | ||
client: client, | ||
logger: logger, | ||
metadataURL: metadataURL, | ||
} | ||
} | ||
|
||
func (f *EnvGCEFingerprint) Get(attribute string, recursive bool) (string, error) { | ||
reqUrl := f.metadataURL + attribute | ||
if recursive { | ||
reqUrl = reqUrl + "?recursive=true" | ||
} | ||
|
||
parsedUrl, err := url.Parse(reqUrl) | ||
if err != nil { | ||
return "", err | ||
} | ||
|
||
req := &http.Request{ | ||
Method: "GET", | ||
URL: parsedUrl, | ||
Header: http.Header{ | ||
"Metadata-Flavor": []string{"Google"}, | ||
}, | ||
} | ||
|
||
res, err := f.client.Do(req) | ||
if err != nil { | ||
return "", err | ||
} | ||
|
||
resp, err := ioutil.ReadAll(res.Body) | ||
res.Body.Close() | ||
if err != nil { | ||
f.logger.Printf("[ERR]: fingerprint.env_gce: Error reading response body for GCE %s", attribute) | ||
return "", err | ||
} | ||
|
||
if res.StatusCode >= 400 { | ||
return "", ReqError{res.StatusCode} | ||
} | ||
|
||
return string(resp), nil | ||
} | ||
|
||
func checkError(err error, logger *log.Logger, desc string) error { | ||
// If it's a URL error, assume we're not actually in an GCE environment. | ||
// To the outer layers, this isn't an error so return nil. | ||
if _, ok := err.(*url.Error); ok { | ||
logger.Printf("[ERR] fingerprint.env_gce: Error querying GCE " + desc + ", skipping") | ||
return nil | ||
} | ||
// Otherwise pass the error through. | ||
return err | ||
} | ||
|
||
func (f *EnvGCEFingerprint) Fingerprint(cfg *config.Config, node *structs.Node) (bool, error) { | ||
if !f.isGCE() { | ||
return false, nil | ||
} | ||
|
||
// newNetwork is populated and addded to the Nodes resources | ||
newNetwork := &structs.NetworkResource{ | ||
Device: "eth0", | ||
} | ||
|
||
if node.Links == nil { | ||
node.Links = make(map[string]string) | ||
} | ||
|
||
keys := []string{ | ||
"hostname", | ||
"id", | ||
} | ||
for _, k := range keys { | ||
value, err := f.Get(k, false) | ||
if err != nil { | ||
return false, checkError(err, f.logger, k) | ||
} | ||
|
||
// assume we want blank entries | ||
node.Attributes["platform.gce."+k] = strings.Trim(string(value), "\n") | ||
} | ||
|
||
// These keys need everything before the final slash removed to be usable. | ||
keys = []string{ | ||
"machine-type", | ||
"zone", | ||
} | ||
for _, k := range keys { | ||
value, err := f.Get(k, false) | ||
if err != nil { | ||
return false, checkError(err, f.logger, k) | ||
} | ||
|
||
index := strings.LastIndex(value, "/") | ||
value = value[index+1:] | ||
node.Attributes["platform.gce."+k] = strings.Trim(string(value), "\n") | ||
} | ||
|
||
// Get internal and external IP (if it exits) | ||
value, err := f.Get("network-interfaces/0/ip", false) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We want to look at all the attached network interfaces. So f.Get("network-interfaces/", true) |
||
if err != nil { | ||
return false, checkError(err, f.logger, "ip") | ||
} | ||
newNetwork.IP = strings.Trim(value, "\n") | ||
newNetwork.CIDR = newNetwork.IP + "/32" | ||
node.Attributes["network.ip-address"] = newNetwork.IP | ||
|
||
value, err = f.Get("network-interfaces/0/access-configs/0/external-ip", false) | ||
if re, ok := err.(ReqError); err != nil && (!ok || re.StatusCode != 404) { | ||
return false, checkError(err, f.logger, "external IP") | ||
} | ||
value = strings.Trim(value, "\n") | ||
if len(value) > 0 { | ||
node.Attributes["platform.gce.external-ip"] = value | ||
} | ||
|
||
var tagList []string | ||
value, err = f.Get("tags", false) | ||
if err != nil { | ||
return false, checkError(err, f.logger, "tags") | ||
} | ||
err = json.Unmarshal([]byte(value), &tagList) | ||
if err == nil { | ||
for _, tag := range tagList { | ||
node.Attributes["platform.gce.tag."+tag] = "true" | ||
} | ||
} else { | ||
f.logger.Printf("[WARN] fingerprint.env_gce: Error decoding instance tags: %s", err.Error()) | ||
} | ||
|
||
var attrDict map[string]string | ||
value, err = f.Get("attributes/", true) | ||
if err != nil { | ||
return false, checkError(err, f.logger, "attributes/") | ||
} | ||
err = json.Unmarshal([]byte(value), &attrDict) | ||
if err == nil { | ||
for k, v := range attrDict { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here |
||
node.Attributes["platform.gce.attr."+k] = strings.Trim(v, "\n") | ||
} | ||
} else { | ||
f.logger.Printf("[WARN] fingerprint.env_gce: Error decoding instance attributes: %s", err.Error()) | ||
} | ||
|
||
// populate Node Network Resources | ||
if node.Resources == nil { | ||
node.Resources = &structs.Resources{} | ||
} | ||
node.Resources.Networks = append(node.Resources.Networks, newNetwork) | ||
|
||
// populate Links | ||
node.Links["gce"] = node.Attributes["platform.gce.id"] | ||
|
||
return true, nil | ||
} | ||
|
||
func (f *EnvGCEFingerprint) isGCE() bool { | ||
// TODO: better way to detect GCE? | ||
|
||
// Query the metadata url for the machine type, to verify we're on GCE | ||
machineType, err := f.Get("machine-type", false) | ||
if err != nil { | ||
if re, ok := err.(ReqError); !ok || re.StatusCode != 404 { | ||
// If it wasn't a 404 error, print an error message. | ||
f.logger.Printf("[ERR] fingerprint.env_gce: Error querying GCE Metadata URL, skipping") | ||
} | ||
return false | ||
} | ||
|
||
match, err := regexp.MatchString("projects/.+/machineTypes/.+", machineType) | ||
if !match { | ||
return false | ||
} | ||
|
||
return true | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update comment.