autostart: Ensure instance is started/stopped by launchd or systemctl
#4139
+677
−254
Conversation
This file contains hidden or 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
norio-nomura
force-pushed
the
improve-autostart
branch
7 times, most recently
from
783c0f2 to
428fcb1
Compare
|
How to test this PR? |
|
Also please explain what issue is being solved by this PR |
opened #4141 |
norio-nomura
force-pushed
the
improve-autostart
branch
2 times, most recently
from
ac9db28 to
31d7007
Compare
norio-nomura
force-pushed
the
improve-autostart
branch
2 times, most recently
from
1cea297 to
b4e6288
Compare
- Hide creating/deleting an autostart entry file into `Register`/`Unregister` as the implementation details. - Separate the `launchd` and `systemd`-specific code into packages. Signed-off-by: Norio Nomura <[email protected]>
…ctl` If the instance isn’t launched by `launchd`, it won’t be stopped on log out. This changes to use `launchctl` or `systemctl` to start/stop the instance if it’s registered to autostart. ## Affected sub commands: - `limactl start` - `limactl stop` - `limactl restart` - `limactl edit` - `limactl shell` ## API changes ### `pkg/autostart` - Introduced `AutoStartedIdentifier()`: - If not empty, it indicates whether the instance was started by `launchd` or `systemd`. - Added `RequestStart()`: - Delegates the operation to `launchd` or `systemd`. - Added `RequestStop()`: - Delegates the operation to `launchd` or `systemd`. ### `pkg/autostart/launchd` - Added `AutoStartedServiceName()`: - Uses the XPC_SERVICE_NAME environment variable as the service name. - Added `RequestStart()`: - Uses `launchctl enable service-target` to avoid failing `bootstrap`. - Uses `launchctl bootstrap domain-target plist-path`. - Added `RequestStop()`: - Uses `launchctl bootout service-target` if the instance is launched by `launchd`. - Added `--progress` to the `limactl` option in `io.lima-vm.autostart.INSTANCE.plist`: - Required to support `limactl start --progress`. ### `pkg/autostart/systemd` - Added `AutoStartedServiceName()`: - Uses `CurrentUnitName()` by `github.com/coreos/go-systemd/v22/util` as the service identifier. - Added `RequestStart()`: - Uses `systemctl --user start unit-name`. - Added `RequestStop()`: - Uses `systemctl --user stop unit-name` if the instance is launched by `systemd`. - Added `--progress` to the `limactl` option in `[email protected]`: - Required to support `limactl start --progress`. ### `pkg/hostagent` - Add `AutoStartedIdentifier` to `Info`. - If not empty, it indicates whether the instance was started by `launchd` or `systemd`. ### `pkg/instance` - `StartWithPaths()`: - Use `autostart.IsRegistered()` to check if the instance is registered to autostart. - If `launchHostAgentForeground` is true, ignore autostart registration. - If the instance is registered to autostart, use `autostart.RequestStart()` instead of launching HostAgent. - `StopGracefully()`: - Use `autostart.RequestStop()`. - `Restart()`, `RestartForcibly()`: - Use `autostart.IsRegistered()` to skip `networks.Reconcile()` if the instance is registered to autostart. Signed-off-by: Norio Nomura <[email protected]>
…hctl bootstrap` Because instances may be stopped without unloading the plist file. e.g. `limactl stop -f` or `limactl factory-reset`. If the plist file is not unloaded, `launchctl bootstrap` will fail. Signed-off-by: Norio Nomura <[email protected]>
norio-nomura
force-pushed
the
improve-autostart
branch
from
b4e6288 to
89c500c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR is formed with two parts:
autoStartManagerto prepare for the following commitlaunchdorsystemctlRefactor to add
autoStartManagerRegister/Unregisteras the implementation details.launchdandsystemd-specific code into packages.Use
launchctlorsystemctlto start/stop the instance if it’s registered to autostart.If the instance isn’t launched by
launchd, it won’t be stopped on log out.Affected sub commands:
limactl startlimactl stoplimactl restartlimactl editlimactl shellAPI changes
pkg/autostartAutoStartedIdentifier():launchdorsystemd.RequestStart():launchdorsystemd.RequestStop():launchdorsystemd.pkg/autostart/launchdAutoStartedServiceName():RequestStart():launchctl enable service-targetto avoid failingbootstrap.launchctl bootstrap domain-target plist-path.RequestStop():launchctl bootout service-targetif the instance is launched bylaunchd.--progressto thelimactloption inio.lima-vm.autostart.INSTANCE.plist:limactl start --progress.pkg/autostart/systemdAutoStartedServiceName():CurrentUnitName()bygithub.com/coreos/go-systemd/v22/utilas the service identifier.RequestStart():systemctl --user start unit-name.RequestStop():systemctl --user stop unit-nameif the instance is launched bysystemd.--progressto thelimactloption in[email protected]:limactl start --progress.pkg/hostagentAutoStartedIdentifiertoInfo.launchdorsystemd.pkg/instanceStartWithPaths():autostart.IsRegistered()to check if the instance is registered to autostart.launchHostAgentForegroundis true, ignore autostart registration.autostart.RequestStart()instead of launching HostAgent.StopGracefully():autostart.RequestStop().Restart(),RestartForcibly():autostart.IsRegistered()to skipnetworks.Reconcile()if the instance is registered to autostart.