mudler/yip

MachineID is confidential and should not be exposed on the network

Open

#86 opened on Apr 17, 2023

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Go (32 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (106 stars)
PR merge metrics
 (PR metrics pending)

Description

The Hostname Plugin allows using MachineID in a template to generate hostname.

Per the manual page and the machine id library used by this project, machine-id is confidential and shouldn't be disclosed in whole or part.

How do we feel about adding "SecuredMachineID" as an available template variable in the hostname plugin to generate a machine-id derived ID using machine.id.ProtectedID("yipCloudInitHostnameConfiguration"), then later deprecating "MachineID" with a warning when its used?

Contributor guide

Research direction
Review the machineid library's ProtectedID function, implement a new template variable 'SecuredMachineID' in the hostname plugin, and add deprecation warnings for 'MachineID'.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70